Conversations

Update a conversation

Update status (open / resolved / pending) and/or assigned_to (user id, or null to clear). At least one field must be present.

patch/{phone_number_id}/conversations/{id}

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/conversations/{id}
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Example:106540352242922
idstring required

Public Kirimdev conversation ID.

Example:cnv_01HXYZABCDEFGHJKMNPQRSTVWX

Request body

status'open' | 'resolved' | 'pending'
assigned_tostring nullable

Response

Updated conversation

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": {
    "id": "cnv_01HXYZABCDEFGHJKMNPQRSTVWX",
    "whatsapp_account": {
      "phone_number_id": "106540352242922",
      "customer": {
        "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
      }
    },
    "labels": [
      {
        "id": "lbl_01HXYZABCDEFGHJKMNPQRSTVWX",
        "name": "VIP"
      }
    ]
  },
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.