API Reference

Conversations

List conversation labels

Lists the account-side conversation labels, paginated with limit / cursor. Each label exposes id and name. WhatsApp-only for now — other providers return 501 unsupported_by_provider.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/labels

Before you call

Use a server-side X-Api-Key for the workspace that owns the resource. Replace every placeholder before running a sample.

Prepare your parameters
account_id
Use data.id from account creation or an account query. Account identifiers belong to the workspace selected by X-Api-Key. Get account

Request parameters

Headers

X-Api-Key
stringrequired

Workspace API key. The workspace is resolved from this header.

Path parameters

account_id
stringrequired

Identifier used in the conversations route.

Query parameters

cursor
string

Opaque next_cursor from a previous response. Omit or leave empty for the first page; invalid or expired cursors are not handled uniformly across providers.

limit
integer

Page size from 1 to 100. Endpoint descriptions state the endpoint-specific default.

minimum: 1 · maximum: 100

Request body

This endpoint does not require a JSON request body.

Understand the result

Use the documented response fields and HTTP status. Successful 204 responses have no body; use X-Request-Id for diagnosis. Follow the related operations for the next step.

Response 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "id": "label_example",
        "name": "VIP"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

Response body

id
string

Conversation label identifier.

name
string

Conversation label display name.

next_cursor
string

Opaque cursor for the next page. Pass it back as cursor; an empty string means there are no more pages.

has_more
boolean

true when more results are available beyond this page.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

409

Conflict

The requested operation conflicts with an existing provider account or resource.

500

Internal Server Error

The service encountered an unexpected error.

501

Not Implemented

The selected provider does not implement this operation.

502

Bad Gateway

The provider adapter or upstream provider could not complete the operation.

If the request fails

Inspect HTTP status and error.code/numeric_code, and keep request_id for diagnosis. Correct invalid parameters, complete required authorization or check runtime state as appropriate. Confirm the outcome before retrying a send or another write. Error reference

invalid_request · 10000 · 400
Check required fields, formats and channel conditions, then correct the request.
invalid_api_key · 11001 · 401
Check X-Api-Key and whether the workspace is active.