Update Suppression

Update Restrictions

Which suppressions can be modified

  • Only suppressions with the manual type can be updated.
  • The request body requires a new email value.
  • Non-manual suppressions such as bounce and complaint are rejected with 422 Unprocessable Entity.
  • The suppression must belong to the workspace in the path.
POST
/v1/workspaces/:workspace/suppressions/:suppression

Update a manual suppression by ID

Path parameters

workspacestring Required

ID of your workspace

suppressionstring Required

Suppression ID

Request body

emailstring Required

Updated email address for the suppression

Update Suppression
curl -X POST https://api.leadpush.io/v1/workspaces/:workspace/suppressions/:suppression \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}" \
-d '{
  "email": "new@example.test"
}'
Response Example
{
"data": {
  "_id": "<suppression_id>",
  "email": "new@example.test",
  "type": "manual",
  "created_at": "2021-01-01T00:00:00.000Z"
}
}