Skip to main content
DELETE
/
v1
/
Call
Delete Calls
curl --request DELETE \
  --url https://api.nlpearl.ai/v1/Call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "callIds": [
    "<string>"
  ],
  "purgeOption": {
    "transcript": true,
    "recording": true,
    "summary": true,
    "variables": true
  }
}
'
true

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Body

The request object containing the list of call IDs to be deleted.

Represents the request object used to delete one or more calls.

​
callIds
string[] | null

The list of unique identifiers of the calls to delete.

​
purgeOption
object | null

Optional. Determines how much of each call is removed. When provided, the calls are kept and only the parts flagged true are stripped (transcript, recording, summary, variables). When omitted, each call is fully deleted: every part is purged, the recording is removed, and the call is marked as deleted.

Response

Returns a boolean indicating if the deletion was successful.

The response is of type boolean.