PATCH
/
calls
/
{id}
/
viewed
curl --request PATCH \
  --url https://app.happyrobot.ai/api/v1/calls/{id}/viewed \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "email": "<string>"
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "type": "Inbound",
  "status": "Dialing",
  "provider": "Twilio",
  "metadata": {
    "call_sid": "<string>",
    "aux_sid": "<string>",
    "from": "<string>",
    "to": "<string>",
    "recording_sid": "<string>",
    "pipeline_id": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "assistant": {
    "id": "<string>",
    "name": "<string>",
    "model": "<string>"
  },
  "hooks": [
    "<string>"
  ],
  "params": {},
  "questions": [
    {
      "question": "<string>",
      "answer": "<string>"
    }
  ],
  "created": "<string>",
  "started": "<string>",
  "duration": 123,
  "viewed_by": [
    "<string>"
  ],
  "samples": [
    "<string>"
  ]
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Path Parameters

​
id
string
required

Body

application/json
Body
​
email
string
required

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:
Dialing,
Connected,
Ended,
Completed,
Missed,
Abandoned,
Failed
​
provider
enum<string>
required

Provider of the call.

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

Call metadata.

​
assistant
object
required

Assistant that handled the call.

​
hooks
string[]
required

Hooks to be executed after the call ends.

​
params
object
required

Dynamic parameters to inject into the templated assistant prompt.

​
created
string
required

Date the call was created.

​
viewed_by
string[]
required

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

​
samples
string[]
required

Sample IDs that are associated with the call.

​
questions
object[]

Questions that the AI assistant will try to answer once the call has finished.

​
started
string

Date the call was connected with the assistant.

​
duration
number

Duration of the call in seconds.

Was this page helpful?

Update a note on a callSet call rating