Contacts

Check contact membership

Checks whether a contact is in the channel account's contact list. WhatsApp requires the contact LID returned as conversation_id by the contact APIs. is_in_contacts=false is a successful 200 result, not a not-found error.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/contacts/membership

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
contact_id: Contact membership target. For WhatsApp, pass the LID returned as conversation_id by the contact APIs and URL-encode @ in the query string.

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 contacts route.

Query parameters

contact_id

stringrequired

Contact membership target. For WhatsApp, pass the LID returned as conversation_id by the contact APIs and URL-encode @ in the query string.

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": {
    "contact_id": "123456789012345@lid",
    "is_in_contacts": true
  }
}

Response body

contact_id

string

Contact identifier from the membership query.

is_in_contacts

boolean

Whether the contact belongs to the target account's channel contact list; false is a successful negative result.

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.