DELETE
/
calls
/
{id}
/
notes
/
{noteId}
curl --request DELETE \
  --url https://app.happyrobot.ai/api/v1/calls/{id}/notes/{noteId} \
  --header 'authorization: <authorization>'
{
  "id": "<string>",
  "organization_id": "<string>",
  "type": "Inbound",
  "status": "Scheduled",
  "provider": "Twilio",
  "metadata": {
    "call_sid": "<string>",
    "from": "+1234567890",
    "to": "+1234567890",
    "recording_sid": "<string>",
    "tags": [
      "<string>"
    ],
    "custom": {
      "clientId": "123",
      "orderId": "456"
    }
  },
  "use_case": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "Kate",
    "transfer_number": "<string>",
    "extract_with_ai": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "string",
        "example": "<string>",
        "required": true
      }
    ],
    "classification_tags": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "language": "en-US",
    "detailed_work_hours": {},
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>",
    "generic_after_hours_message": "<string>",
    "enable_detailed_work_hours": true,
    "keywords": [
      "<string>"
    ],
    "hooks": [
      {
        "url": "<string>",
        "headers": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "params": {},
    "amd": true,
    "amd_behavior": "Hangup",
    "amd_messages": {},
    "sample_labels": [
      {
        "name": "<string>",
        "color": "slate"
      }
    ],
    "hidden": true,
    "evaluation_models": [
      "<string>"
    ],
    "max_duration_mins": 123,
    "recorded_message_inbound": true,
    "recorded_message_outbound": true,
    "show_original_caller_id": true,
    "disable_end_call_after_n_reminders": true,
    "model": "<string>"
  },
  "prompt_id": "<string>",
  "agent": {
    "id": "<string>",
    "name": "<string>"
  },
  "language": "en-US",
  "params": {},
  "extraction": {},
  "classification": {
    "tag": "<string>",
    "reasoning": "<string>"
  },
  "created": "2024-01-01T01:01:01Z",
  "duration": 123,
  "viewed_by": [
    "<string>"
  ],
  "parent_call_id": "<string>",
  "notes": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "content": "<string>",
      "flagged": true,
      "created_at": "2024-01-01T01:01:01Z"
    }
  ],
  "samples": [
    "<string>"
  ],
  "ratings": [
    {
      "emoji": "✅",
      "email": "jsmith@example.com",
      "created": "2024-01-01T01:01:01Z"
    }
  ],
  "scheduled_for": "2024-01-01T01:01:01Z",
  "use_backup": true,
  "wait_until_awake": true,
  "campaign_id": "<string>",
  "max_duration_mins": 123,
  "transfer_contact_email": "<string>",
  "costs": {
    "created": "2023-11-07T05:31:56Z",
    "total_costs": 123,
    "voip": {
      "external": true,
      "amd_cost": 123,
      "call_cost": 123,
      "total_cost": 123,
      "pricing_id": "<string>"
    },
    "transcriber": {
      "total_cost": 123,
      "pricing_id": "<string>"
    },
    "llm": {
      "input_cost": 123,
      "output_cost": 123,
      "total_cost": 123,
      "input_pricing_id": "<string>",
      "output_pricing_id": "<string>"
    },
    "tts": {
      "total_cost": 123,
      "pricing_id": "<string>"
    },
    "per-minute": {}
  }
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Path Parameters

​
id
string
required

ID of the call.

Required string length: 24
​
noteId
string
required

ID of the note.

Response

200
application/json
200
​
id
string
required

Unique identifier for the call.

​
organization_id
string
required

Organization ID.

​
type
enum<string>
required

Type of the call.

Available options:
Inbound,
Outbound
​
status
enum<string>
required

Status of the call.

Available options:
Scheduled,
Queued,
Initiated,
Ringing,
In progress,
Transferred,
Completed,
AMD Terminated,
Busy,
No answer,
Canceled,
Failed
​
provider
enum<string>
required

Provider of the call.

Available options:
Twilio,
Web,
Chat
​
metadata
object
required

Call metadata.

​
use_case
object
required

Use case that handled the call.

​
agent
object
required

Agent that handled the call.

​
language
enum<string>
required

Language of the call.

Available options:
en-US,
en-GB,
es-MX,
es-ES,
es-CO,
pt-PT,
de-DE,
fr-FR,
pl-PL,
ro-RO,
it-IT,
zh-CN,
hi-IN,
ja-JP,
sv-SE
​
created
string
required

Date the call was created.

Example:

"2024-01-01T01:01:01Z"

​
viewed_by
string[]
required

User emails that have viewed the call in the Happyrobot App.

​
prompt_id
string

Prompt ID.

​
params
object

Dynamic parameters to inject into the templated use case prompt.

​
extraction
object

AI extracted data from the call.

​
classification
object

Tag classification of the call.

​
duration
number

Duration of the call in seconds.

​
parent_call_id
string

Parent call ID in the case of repeated calls.

​
notes
object[]

Notes associated with the call.

​
samples
string[]

Sample IDs that are associated with the call.

​
ratings
object[]

Ratings emojis associated with the call.

​
scheduled_for
string

ISO 8601 UTC datetime the call is scheduled for.

Example:

"2024-01-01T01:01:01Z"

​
use_backup
boolean

Whether the backup model was used.

​
wait_until_awake
boolean

Whether the call should wait until the model is awake.

​
campaign_id
string

Campaign ID.

​
max_duration_mins
integer

Specifies the maximum duration of the call in minutes. This value takes precedence over the maximum duration specified in the use-case. If neither is provided, the default duration is 10 minutes.

​
transfer_contact_email
string

Email of the transfer contact.

​
costs
object

Costs associated with the call.

Was this page helpful?

Set call ratingDelete a call