Upsert a workspace-platform-level suppression

Upsert a workspace-platform-level suppression

post

https://api.bird.comhttp://localhost:3000https://api.bird.ai

/workspaces/{workspaceId}/suppressions/{platformId}/{identifierValue}

Authorizations

MessageBird_userMessageBird_accessKey

AuthorizationstringRequired

An access token issued to a user.

Path parameters

workspaceIdstring · uuidRequired

Your workspace identifier.

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

platformIdstring · min: 1 · max: 250Required

The ID of a platform.

Example: email-sparkpost

identifierValuestring · min: 1 · max: 500Required

The identifier value

Example: [email protected]

Body

application/json

contactSuppressedMarketingAtstring · date-time · nullableOptional

contactSuppressedMarketingReasonstring · min: 1 · max: 250 · nullableOptional

contactSuppressedTransactionalAtstring · date-time · nullableOptional

contactSuppressedTransactionalReasonstring · min: 1 · max: 250 · nullableOptional

marketerSuppressedMarketingAtstring · date-time · nullableOptional

marketerSuppressedMarketingReasonstring · min: 1 · max: 250 · nullableOptional

marketerSuppressedTransactionalAtstring · date-time · nullableOptional

marketerSuppressedTransactionalReasonstring · min: 1 · max: 250 · nullableOptional

Responses

200

Upserted

application/json

platformIdstring · enumRequiredPossible values:

platformTypestring · enumOptionalPossible values:

identifierValuestringRequired

contactSuppressedMarketingAtstring · date-time · nullableOptional

contactSuppressedMarketingReasonstring · nullableOptional

contactSuppressedTransactionalAtstring · date-time · nullableOptional

contactSuppressedTransactionalReasonstring · nullableOptional

marketerSuppressedMarketingAtstring · date-time · nullableOptional

marketerSuppressedMarketingReasonstring · nullableOptional

marketerSuppressedTransactionalAtstring · date-time · nullableOptional

marketerSuppressedTransactionalReasonstring · nullableOptional

404

Workspace or platform invalid

application/json

422

Invalid suppression

application/json

post

/workspaces/{workspaceId}/suppressions/{platformId}/{identifierValue}

HTTPcURLJavaScriptPython

POST /workspaces/{workspaceId}/suppressions/{platformId}/{identifierValue} HTTP/1.1
Host: api.bird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 421

{
  "contactSuppressedMarketingAt": "2026-03-13T15:56:49.684Z",
  "contactSuppressedMarketingReason": "text",
  "contactSuppressedTransactionalAt": "2026-03-13T15:56:49.684Z",
  "contactSuppressedTransactionalReason": "text",
  "marketerSuppressedMarketingAt": "2026-03-13T15:56:49.684Z",
  "marketerSuppressedMarketingReason": "text",
  "marketerSuppressedTransactionalAt": "2026-03-13T15:56:49.684Z",
  "marketerSuppressedTransactionalReason": "text"
}

{
  "platformId": "apple-business-chat",
  "platformType": "sms",
  "identifierValue": "text",
  "suppressedForOriginators": [
    {
      "channelIdentifier": "text"
    }
  ],
  "suppressedFor": {
    "marketing": true,
    "transactional": true
  },
  "reasons": {
    "marketing": "unknown",
    "transactional": "unknown"
  },
  "contactSuppressedMarketingAt": "2026-03-13T15:56:49.684Z",
  "contactSuppressedMarketingReason": "text",
  "contactSuppressedTransactionalAt": "2026-03-13T15:56:49.684Z",
  "contactSuppressedTransactionalReason": "text",
  "marketerSuppressedMarketingAt": "2026-03-13T15:56:49.684Z",
  "marketerSuppressedMarketingReason": "text",
  "marketerSuppressedTransactionalAt": "2026-03-13T15:56:49.684Z",
  "marketerSuppressedTransactionalReason": "text",
  "contact": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "computedDisplayName": "John Doe",
    "createdAt": "2026-03-13T15:56:49.684Z",
    "updatedAt": "2026-03-13T15:56:49.684Z",
    "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
    "featuredIdentifiers": [
      {
        "key": "emailaddress",
        "value": "[email protected]"
      }
    ],
    "attributes": {
      "firstName": "John",
      "lastName": "Smith",
      "rating": 9.6,
      "cookiesAccepted": false,
      "labels": [
        "A",
        "B",
        "C"
      ]
    },
    "identifierCount": 2,
    "accountIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "listIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "companyRefs": [
      "text"
    ],
    "isAnonymous": true
  }
}