Skip to main content
POST
/
api
/
contacts.delete
Delete a contact
curl --request POST \
  --url https://{notifuseDomain}/api/contacts.delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "email": "user@example.com"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

API token for authentication

Body

application/json
​
workspace_id
string
required

The ID of the workspace

Example:

"ws_1234567890"

​
email
string<email>
required

Email address of the contact to delete

Example:

"user@example.com"

Response

Contact deleted successfully

​
success
boolean

Whether the deletion was successful

Example:

true