Create WhatsApp integration

POST/api/integrations/whatsapp/numbers

Creates a new WhatsApp number integration placeholder for the workspace.

Request Body

application/json

Request payload for Create WhatsApp integration.

name*string

Display name for the WhatsApp integration instance.

Length1 <= length <= 120

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/integrations/whatsapp/numbers" \  -H "Content-Type: application/json" \  -d '{    "name": "Main sales line"  }'

{
  "id": "string",
  "workspaceId": "string",
  "type": "string",
  "data": {
    "type": "string",
    "name": "string",
    "status": "string",
    "kapsoCustomerId": "string",
    "setupLinkId": "string",
    "phoneNumberId": "string",
    "businessAccountId": "string",
    "whatsappConfigId": "string",
    "provisionedPhoneNumberId": "string",
    "displayPhoneNumber": "string",
    "connectedAt": "string",
    "errorCode": "string"
  },
  "createdAt": "string",
  "updatedAt": "string"
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Create WhatsApp integration

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`