API reference
Delete a conversation.
const url = 'https://api.helping.io/v1/conversations/example';const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request DELETE \ --url https://api.helping.io/v1/conversations/example \ --header 'Authorization: Bearer <token>'The conversation and its history stop being reachable and it can no longer be continued. Deleting twice is not an error.
Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”The opaque conv_... id of the conversation
Responses
Section titled “ Responses ”{id, object: "conversation.deleted", deleted: true}.
The answer to a conversation delete.
object
Always true.
The conversation’s opaque id, echoed from the request.
Always conversation.deleted.
Examplegenerated
{ "deleted": true, "id": "example", "object": "example"}Missing or invalid API key (the error envelope)
The key is not entitled to what the request asked for (the error envelope)
No such conversation, or one this key cannot reach.
This organization has exhausted its delete allowance; retry after the Retry-After header.
The request could not be completed; quote the x-request-id response header when reporting it.
The request could not be served this instant; retry after the Retry-After header.