When to Use the Remove Endpoint
Use the/resource/remove/
endpoint when:
- A resource has served its purpose and is no longer relevant to the collection.
- Data in a resource needs be removed.
DELETE
request to the /resource/remove/
endpoint with the required parameters in the body.
Required Parameters
Parameter | Type | Description |
---|---|---|
collection_id | String | The unique ID of the collection the resource belongs too |
resource_id | String | The unique ID of the resource to delete. |
Request Example
Successful Response
Upon successful deletion, the endpoint returns a success flag. Example ResponseField | Description |
---|---|
success | Indicates whether the deletion was successful. |