OCT-103 Gumlet outreach
POST/purge/{subdomain}Deprecated

Purge cached images

Purges cached images for the image source associated with a subdomain. Use subdomain to identify the source and optionally provide image paths without query parameters to limit which cached images are purged. This operation is closing down and will be removed; the removal date is not specified.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
subdomainstringrequired

The image source subdomain; for example.gumlet.com, provide example.

Optional list of image paths to purge for the specified subdomain.

pathsarray<string>optional

An array of path of images to purge. It should be provided without any query parameters.

4 status codes
200Returns an object containing the purge status.
statusstringrequired
400Returned when the request is malformed.

One documented failure

  • invalid_parameter_value

    The parameter value is invalid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks the required role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

A 400 is returned for a bad request, a 401 when the API key or bearer token is missing or invalid, and a 403 when the account is unpaid or lacks the required role permissions. The subdomain path parameter is the source subdomain only, not the full image URL hostname. Provide each paths entry without query parameters.