curl --request PATCH \
--url https://app.happyrobot.ai/api/v1/use-cases/{id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '{
"name": "Carrier Sales",
"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",
"keywords": [
"<string>"
],
"hooks": [
{
"url": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"params": {},
"amd": true,
"amd_behavior": "Hangup",
"amd_messages": {},
"timezone": "<string>",
"work_start": "<string>",
"work_end": "<string>",
"detailed_work_hours": {},
"enable_detailed_work_hours": true,
"generic_after_hours_message": "<string>",
"hidden": true,
"max_duration_mins": 123,
"recorded_message_inbound": true,
"recorded_message_outbound": true,
"show_original_caller_id": true,
"disable_end_call_after_n_reminders": true
}'
{
"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
}
Update an existing use case.
curl --request PATCH \
--url https://app.happyrobot.ai/api/v1/use-cases/{id} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--data '{
"name": "Carrier Sales",
"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",
"keywords": [
"<string>"
],
"hooks": [
{
"url": "<string>",
"headers": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"params": {},
"amd": true,
"amd_behavior": "Hangup",
"amd_messages": {},
"timezone": "<string>",
"work_start": "<string>",
"work_end": "<string>",
"detailed_work_hours": {},
"enable_detailed_work_hours": true,
"generic_after_hours_message": "<string>",
"hidden": true,
"max_duration_mins": 123,
"recorded_message_inbound": true,
"recorded_message_outbound": true,
"show_original_caller_id": true,
"disable_end_call_after_n_reminders": true
}'
{
"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
}
Your API key for authentication. Use Bearer format.
"Bearer API_KEY"
ID of the use case.
24
Body
The body is of type object
.
200
The response is of type object
.
Was this page helpful?