Delete a collection model

DELETE

/collection-models/{handle}

const url = 'https://acme.mykreezalid.com/api/v1/collection-models/example?by=handle';
const options = {method: 'DELETE', headers: {Authorization: 'Basic <credentials>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url 'https://acme.mykreezalid.com/api/v1/collection-models/example?by=handle' \
  --header 'Authorization: Basic <credentials>'

Its collections stay where they are, online, on their own: each first takes what the model gave it (name, texts, SEO, indexing), so that it shows as before.

Authorizations

basic

Parameters

Path Parameters

handle

required

string

The model’s handle, or its id with by=id

Query Parameters

string

default: handle

Allowed values: handle id

How the path names the collection: handle (the default, which also finds an integrator’s source handle) or id. A handle may be made of digits only, so an id is never guessed.

Responses

200

Deleted

application/json

object

success

boolean

message

string

Example

{
  "success": true,
  "message": "Collection model deleted"
}

400

by is not handle or id, or with by=id the reference is not a whole number

application/json

Why a collection or collection model request was refused.

object

success

boolean

message

string

errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
  "success": false,
  "message": "Collection handle is required"
}

404

Collection model not found

application/json

Why a collection or collection model request was refused.

object

success

boolean

message

string

errors

The problems found: for a collection, field by field, the rules not met and their messages. Present only when there are some.

Example

{
  "success": false,
  "message": "Collection handle is required"
}