Inbox · Messages

Create a conversation label

Creates a conversation label.

POSThttps://api.pozy.ai/v1/inbox/labels
createInboxLabel

Guide: Messages

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

  • accountIdstringrequired
  • namestringrequired

Example

curl -X POST "https://api.pozy.ai/v1/inbox/labels" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "name": "Acme"
}'

Response

201 on success

  • labelobject
    • idstring
    • namestring
201 response
{
  "label": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Messages