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

Create a workspace for the organization.

POST/organizations/{organizationId}/workspaces

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

Response

201404422

Created

Body

application/json

id*string (uuid)

Workspace ID.

organizationId*string (uuid)

ID of the organization this workspace is part of.

status*enum

Current status

active

name*WorkspaceName (string)

The display name for the workspace

descriptionWorkspaceDescription (string)

The description for the workspace

dataPolicy*DataPolicy

The data storage policy for a resource.

createdAt*string (date-time)

When the workspace was created.

updatedAt*string (date-time)

When the workspace was last updated.

Request

JavaScriptCurl

const response = await fetch('/organizations/{organizationId}/workspaces', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "dataPolicy": {
        "group": "eu",
        "regions": [
          {
            "region": "eu-west-1"
          }
        ]
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "active",
  "name": "text",
  "description": "text",
  "dataPolicy": {
    "group": "eu",
    "regions": [
      {
        "region": "eu-west-1"
      }
    ],
    "piiStrategy": "default"
  },
  "createdAt": "2024-07-27T06:40:44.259Z",
  "updatedAt": "2024-07-27T06:40:44.259Z"
}

Example request

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