Destination management API

Control which countries can receive SMS at the workspace level by allowing or blocking destinations. Destinations are ISO 3166-1 alpha-2 country codes.

Endpoints

GET

/workspaces/{workspaceId}/destination-management/capability/{capabilityName}

Get a destination management configuration for a given workspace/capability.

响应载荷

destinations

object

必填

organizationId

string

必填

workspaceId

string

必填

capabilityName

string

必填

createdAt

string

必填

updatedAt

string

必填

代码示例

curl -X GET 'https://api.bird.com/workspaces/{workspaceId}/destination-management/capability/{capabilityName}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

代码示例

GET /workspaces/{workspaceId}/destination-management/capability/sms

Response:

代码示例

{
  "organizationId": "5a3d8cf1-3aaf-4b56-a2e0-260b28c0a0d0",
  "workspaceId": "e9d00796-afb3-458e-ad85-64a1bdefe3aa",
  "capabilityName": "sms",
  "destinations": {
    "US": "allowed",
    "BR": "blocked"
  },
  "createdAt": "2025-01-02T15:04:05Z",
  "updatedAt": "2025-01-09T10:11:12Z"
}

Allow destinations

POST

/workspaces/{workspaceId}/destination-management/capability/{capabilityName}/allow

Adds a list of allowed countries to a destination management configuration for a given workspace/capability.

请求载荷

destinations

array of string

必填

响应载荷

destinations

object

必填

organizationId

string

必填

workspaceId

string

必填

capabilityName

string

必填

createdAt

string

必填

updatedAt

string

必填

代码示例

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/destination-management/capability/{capabilityName}/allow' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

代码示例

POST /workspaces/{workspaceId}/destination-management/capability/sms/allow

Notes:

destinations is an array of country codes
This will add specific destinations
Destinations are ISO 3166-1 alpha-2 country codes.

Request body:

代码示例

{
  "destinations": ["US", "CA"]
}

Response (full config):

代码示例

{
  "organizationId": "5a3d8cf1-3aaf-4b56-a2e0-260b28c0a0d0",
  "workspaceId": "e9d00796-afb3-458e-ad85-64a1bdefe3aa",
  "capabilityName": "sms",
  "destinations": {
    "US": "allowed",
    "CA": "allowed",
    "BR": "blocked"
  },
  "createdAt": "2025-01-02T15:04:05Z",
  "updatedAt": "2025-01-09T10:11:12Z"
}

Block destinations

POST

/workspaces/{workspaceId}/destination-management/capability/{capabilityName}/block

Adds a list of blocked countries to a destination management configuration for a given workspace/capability.

请求载荷

destinations

array of string

必填

响应载荷

configuration

object

必填

显示子属性

configuration.destinations

object

必填

configuration.organizationId

string

必填

configuration.workspaceId

string

必填

configuration.capabilityName

string

必填

configuration.createdAt

string

必填

configuration.updatedAt

string

必填

message

string

必填

代码示例

curl -X POST 'https://api.bird.com/workspaces/{workspaceId}/destination-management/capability/{capabilityName}/block' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

代码示例

POST /workspaces/{workspaceId}/destination-management/capability/sms/block

Notes:

destinations is an array of country codes
This will remove specific destinations
Destinations are ISO 3166-1 alpha-2 country codes.

Request body:

代码示例

{
  "destinations": ["BR", "IN"]
}

Response:

代码示例

{
  "message": "Destinations have been blocked. If the block is not temporary, please cancel any associated subscriptions to prevent unexpected charges.",
  "configuration": {
    "organizationId": "5a3d8cf1-3aaf-4b56-a2e0-260b28c0a0d0",
    "workspaceId": "e9d00796-afb3-458e-ad85-64a1bdefe3aa",
    "capabilityName": "sms",
    "destinations": {
      "US": "allowed",
      "BR": "blocked",
      "IN": "blocked"
    },
    "createdAt": "2025-01-02T15:04:05Z",
    "updatedAt": "2025-01-09T10:11:12Z"
  }
}

Upsert config

PUT

/workspaces/{workspaceId}/destination-management/capability/{capabilityName}

Upsert a destination management configuration for a given workspace/capability.

请求载荷

destinations

object

必填

响应载荷

destinations

object

必填

organizationId

string

必填

workspaceId

string

必填

capabilityName

string

必填

createdAt

string

必填

updatedAt

string

必填

代码示例

curl -X PUT 'https://api.bird.com/workspaces/{workspaceId}/destination-management/capability/{capabilityName}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'

代码示例

PUT /workspaces/{workspaceId}/destination-management/capability/sms

Notes:

destinations is a map of country code → status (allowed or blocked).
This will fully overwrite your existing config
Any destination not present in the map is treated as blocked.
Destinations are ISO 3166-1 alpha-2 country codes.

Request body:

代码示例

{
  "destinations": {
    "US": "allowed",
    "BR": "blocked"
  }
}