Conversations

Delete a conversation

Deletes a conversation. By default it is moved to the Trash; pass permanent=true to delete it irreversibly.

Deleting a conversation that is still being processed cancels it first: processing stops and the credits it consumed are refunded. A few late pipeline stages cannot be cancelled — aligning, retrying, unlocked, automatic_transcribing_second_part, and pro_transcribing/human_translating once the human work has started — and deleting a conversation in one of those states returns 409.

workspace_id is not needed here: the conversation id already identifies the workspace. It is only required when listing, creating and updating conversations.

delete/conversations/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required
Example:e458099e7f8da14f9625854ba7b6a026917ad306

ID of the conversation.

Query parameters

permanentboolean

When true, the action is irreversible. Otherwise the conversation can be found in the Trash.

Response

The conversation was deleted.

Changes

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