Skip to main content
DELETE
Delete Collection by External ID

Authorizations

X-Authorization
string
header
required

API Scope: "Collections (write)"

Path Parameters

externalId
string
required

The identifier used by an external source to identify the collection.

Maximum string length: 64
Example:

"564400c7-7a6b-4f29-b6a5-7bb580b2992c"

Response

Success

id
integer<int64>
required

The unique identifier for the collection, created by Loop.

Example:

23141001200513

external_id
string
required

The identifier used by an external source to identify the collection.

Example:

"564400c7-7a6b-4f29-b6a5-7bb580b2992c"

success
boolean
required

Whether the collection was successfully deleted.

Example:

true