Description
Unsubscribe from a case.
Request
HTTP Method: DELETE
| Parameter | Description |
|---|---|
| user_email | The email of the user to unsubscribe. |
| Path Parameter | Description |
|---|---|
| case_id | ID of the case. |
Sample request
curl -X POST \
https://<<META.tenant.domain>>/api/v1/cases/<<case_id>>/unsubscribe \
-H 'content-type: application/json' \
-H 'x-user-token: <<CREDENTIAL.tines_api_key>>' \
-d '{
"user_email": "jane@tines.io"
}'
Response
A successful request will return a JSON object with the id of the destroyed subscriber record.
Field description
| Parameter | Description |
|---|---|
| destroyed_id | The ID of the destroyed subscriber record. |
Sample response
{
"destroyed_id": 8495
}