👨🏽‍💻 Webchat

Collection of endpoints useful to get and post information specific to a Vambe Webchat

💻 Webchat Contact Metadata

Use this endpoint to add metadata to a webchat contact, allowing you to enrich conversations with custom attributes such as CRM IDs, UTM sources, user preferences, or any internal identifiers.

🔽 `POST /api/public/webchat/contact/add-metadata` – Add Metadata for a Webchat Contact

Click to expand full details

🔹 URL

POST /api/public/webchat/contact/add-metadata

🔹 Headers

Name	Type	Required	Description
`x-api-key`	string	✅	Your API key for authentication

🔹 Body Parameters

Field	Type	Required	Description
`metadata`	object	✅	A key-value object with custom metadata fields
`externalUserId`	string	✅	Unique external ID of the webchat contact

🔹 Example Request

curl --request POST \
  'https://api.vambe.me/api/public/webchat/contact/add-metadata' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --data-raw '{
    "metadata": {
      "utm_source": "google",
      "preferred_language": "en",
      "crm_id": "crm_1029"
    },
    "externalUserId": "webchat_user_456"
  }'

🔹 Response Codes

Code	Meaning	Description
201	Created	Metadata saved successfully
400	Bad Request	One or more parameters are invalid
401	Unauthorized	Missing or invalid API key

Updated 9 days ago