Create Suppression

Creation Behavior

What happens when a suppression is created

  • The request body only requires an email.
  • Successful creates return 201 Created with the created suppression record.
  • Developer-created suppressions are always stored with the manual type.
  • The email must be valid and must pass the workspace suppression uniqueness checks.
POST
/v1/workspaces/:workspace/suppressions

Create a manual workspace suppression

Path parameters

workspacestring Required

ID of your workspace

Request body

emailstring Required

Email address to suppress

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