Connectors

Connectors

Create a new connector

post

Creates a connector for a specified platform and optionally performs WhatsApp onboarding.

Body

application/json

workspace_idstring · uuidOptional

The workspace ID

namestringOptional

Name of the connector

statusstringOptional

Status of the connector

regionstringOptional

Region for the connector

platformstring · enumOptional

Platform type (e.g., 'whatsapp' or 'sms')

Possible values:

whatsapp_business_account_idstring · nullableOptional

WhatsApp Business Account ID

business_manager_account_idstring · nullableOptional

Business Manager Account ID

codestring · nullableOptional

Authorization code for onboarding

Responses

200

Connector created successfully

No content

400

Validation error or onboarding error

application/json

post

/api/workspaces/{workspace_id}/connectors

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspace_id}/connectors HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 212

{
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "status": "text",
  "region": "text",
  "platform": "whatsapp",
  "whatsapp_business_account_id": "text",
  "business_manager_account_id": "text",
  "code": "text"
}

No content