No-code docs
Resources

Creating a workspace for your customer

For every customer that you want to onboard onto WhatsApp in your platform you should create a separate workspace in Bird CRM. This will ensure that your customers resources including phone numbers, messages templates and channels are kept separate from other customers.

Once you have created a workspace you should associate the workspace ID with the customer account in your platform.

Note: As best practice you can also create an access key, role and policy scoped to each customer workspace. See the following documentations to create access keys, policies and roles programmatically.

To create a new workspace make the following request. The region parameter you specify will determine where your customers data is hosted in Bird CRM. The following workspaces are available as options:

  • eu-west-1

  • ap-south-1

  • us-west-1

Create workspace

post

Create a workspace for the organization.

Authorizations
Path parameters
organizationIdstringrequired

The organization ID

Body
namestring · min: 1 · max: 256required

The display name for the workspace

descriptionstring · min: 1 · max: 256optional

The description for the workspace

dataPolicyobjectrequired

The data storage policy for a resource.

configurationobject | nullableoptional

Responses
curl -L \
  --request POST \
  --url '/organizations/{organizationId}/workspaces' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "dataPolicy": {
      "group": "eu-west-1",
      "regions": [
        {
          "region": "eu-west-1",
          "priority": 1
        }
      ]
    },
    "configuration": {
      "domain": "example.com"
    }
  }'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "statusTransitions": [
    {
      "fromStatus": "active",
      "toStatus": "active",
      "reason": "org-banned",
      "comment": "text",
      "transitionedAt": "2025-03-29T04:58:43.829Z",
      "transitionedBy": {
        "type": "user",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu-west-1",
    "regions": [
      {
        "region": "eu-west-1",
        "priority": 1
      }
    ],
    "piiStrategy": "default"
  },
  "configuration": {
    "domain": "example.com"
  },
  "createdAt": "2025-03-29T04:58:43.829Z",
  "updatedAt": "2025-03-29T04:58:43.829Z"
}

Created

curl --location 'https://api.bird.com/organizations/{{orgId}}/workspaces' \
--header 'Content-Type: application/json' \
--header 'Authorization: AccessKey {{key}}' \
--data '{
    "name":"{{name}}",
    "Description":"{{description}}",
    "dataPolicy":{
        "Group":"{{region}}"
        "regions":[{"region":"{{region}}","priority":0}]
    }
}'
Buying a number through Bird

Last updated

Was this helpful?