Skip to main content
PATCH
/
assistant
/
{assistantId}
cURL
curl --request PATCH \
  --url https://api.clarionhealth.com/v1/assistant/{assistantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "model": {},
  "first_message": "<string>",
  "webhook_url": "<string>",
  "analysis_plan": {}
}'
{
  "id": 123,
  "name": "<string>",
  "organization_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "model": {},
  "voice": {},
  "first_message": "<string>",
  "max_duration_seconds": 123,
  "voicemail_message": "<string>",
  "webhook_url": "<string>",
  "is_webhook_secret_set": true,
  "analysis_plan": {}
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
assistantId
string
required

ID of assistant to update

Body

application/json

Assistant properties to update

​
model
object

The updated language model configuration for the assistant

​
first_message
string

The updated initial message the assistant will use

​
webhook_url
string

The updated URL the assistant will send the end of call report to

​
analysis_plan
object

The updated analysis plan for the assistant

Response

Assistant updated successfully

​
id
integer
required

The unique identifier for the assistant

​
name
string
required

The name of the assistant

​
organization_id
integer
required

The identifier of the organization the assistant belongs to

​
created_at
string<date-time>
required

The timestamp when the assistant was created

​
updated_at
string<date-time>
required

The timestamp when the assistant was last updated

​
model
object

The language model configuration for the assistant

​
voice
object

The voice model configuration for the assistant

​
first_message
string

The initial message the assistant will use

​
max_duration_seconds
integer

The maximum duration in seconds for the assistant's interaction

​
voicemail_message
string

The message the assistant will leave as a voicemail

​
webhook_url
string

The URL the assistant will send the end of call report to

​
is_webhook_secret_set
boolean

Whether a secret is set for the webhook

​
analysis_plan
object

The analysis plan for the assistant

⌘I