Close conversation

Close (archive) the conversations of a contact.

POST/contacts/:uuid/conversation/close

Authentication

This endpoint authenticates with your API key sent in the X-API-Key header (ek_live_... format). You can manage your API keys from the Dev Tools section of the dashboard.

Path parameters

Parameter	Type	Required	Description
`uuid`	String	Required	UUID of the contact whose conversations will be closed.

Example request

bash

curl -X POST "https://eclectic-api-537143970188.us-central1.run.app/api/external/v2/contacts/eb2b914a-977e-4ab8-96e7-b886698b3eac/conversation/close" \
  -H "X-API-Key: ek_live_your_api_key_here"

Example response

json

{
  "contact": [
    {
      "uuid": "eb2b914a-977e-4ab8-96e7-b886698b3eac",
      "name": "John Doe",
      "phoneNumber": "+56912345678",
      "avatarUrl": null,
      "createdAt": "2024-09-23T20:09:10Z",
      "source": "whatsapp",
      "closedAt": "2024-09-24T12:00:00Z",
      "href": "https://dash.try-eclectic.com/contacts/eb2b914a977e4ab896e7b886698b3eac",
      "conversationHref": "https://dash.try-eclectic.com/chat/f3670b13446b412796238b1cd78899f9",
      "tags": [],
      "assignedUser": null,
      "customFields": {}
    }
  ]
}

Notes

The change applies to all of the contact's conversations. closedAt reflects the closing time.
No request body is required.
Possible errors: 401 (invalid or missing API key), 404 (contact not found).