v1

latestOpenAPI 3.0.32026-07-13201451.3 KB
Contacts

Create contacts for a chatbot

Creates one or more contacts for a specific chatbot (max 1000 per request)

post/chatbots/{chatbotId}/contacts

Path parameters

chatbotIdstring required

ID of the chatbot

Request body

Example request

{
  "users": [
    {
      "external_id": "user_123",
      "name": "John Doe",
      "email": "john@example.com",
      "phonenumber": "+1234567890",
      "stripe_accounts": [
        {
          "label": "main",
          "stripe_id": "cus_123abc456",
          "stripe_email": "john@example.com"
        }
      ],
      "custom_attributes": {
        "department": "Sales",
        "subscription_tier": "Premium"
      }
    }
  ]
}

Response

Contacts created successfully

messagestring

Example response

{
  "message": "Success",
  "data": [
    {
      "id": "contact_internal_123",
      "external_id": "user_123",
      "name": "John Doe",
      "email": "john@example.com",
      "phonenumber": "+1234567890",
      "stripe_accounts": [
        {
          "label": "main",
          "stripe_id": "cus_123abc456",
          "stripe_email": "john@example.com"
        }
      ],
      "custom_attributes": {
        "department": "Sales",
        "subscription_tier": "Premium"
      },
      "created_at": 1704067200,
      "updated_at": 1704153600
    }
  ]
}