Sign in

v1

latestOpenAPI 3.0.12026-07-2412598.8 KB
Contacts

Update Contacts

The Update Contact (Async) API lets you update existing contacts asynchronously. It supports updating attributes and modifying contact subscription preferences.

post/contact/update

Headers

api-keystring required

API key for authentication. You must have a unique and valid API key.

Content-Typestring required

Specifies the request content type. Must be application/json.

Request body

Example request

{
  "data": {
    "contact_type": "identified",
    "contacts": [
      {
        "contact_id": 12345,
        "guid": "550e8400-e29b-41d4-a716-446655440000",
        "attributes": {
          "FIRST_NAME": "John",
          "AGE": "30"
        },
        "email": "john.doe@example.com",
        "mobile": "919876543210",
        "sms_subscription_reason": "Customer opted out via SMS",
        "email_subscription_reason": "Customer unsubscribed via email link",
        "audience_details": [
          {
            "audience_id": [
              101,
              202
            ],
            "audience_name": [
              "Newsletter",
              "VIP_Group"
            ],
            "audience_type": "list"
          }
        ],
        "subscription_details": [
          {
            "subscription_channel": "rcs",
            "subscription_reason": "Customer opted out via WhatsApp"
          }
        ]
      }
    ]
  }
}

Response

Success Response: The request was successfully submitted and will be processed asynchronously.

request_idstring required

Unique identifier for the submitted request.

codeinteger required

HTTP status code of the API response.

status'success' | 'failed' required

Status of the API request.

messagestring

Human-readable response message.

Example response

{
  "request_id": "a7add3e4-2206-49f6-927e-3dfd917b906a",
  "code": 200,
  "status": "success",
  "message": "Your request was accepted successfully. It may take a few minutes to process your request."
}