Set message details
Declare the details take_a_message records on EVERY message, a property address, a job number, a date, whether or not the caller gives them. Each declared detail becomes a required argument the agent must answer during the call, and its own labelled line in the message email; one the caller will not give is recorded as "not given" instead of being left off. Use this when a team matches messages to jobs or accounts by hand, where a field they can see is workable and a field that simply is not there looks like a complete message about something else. Prefer it over wording the requirement into the system prompt: prose asks the model to remember, this asks the schema. `details` replaces the whole list; pass an empty array to turn it off. The change lands on the draft version.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Header Parameters
A key you choose, such as a UUID, that makes this POST safe to retry. Within 24 hours the same key and request answers with the first successful answer and runs nothing, the same key with a different request answers 422 idempotency_key_reused, and a key whose request is still running answers 409 idempotency_key_in_use. A failed request keeps nothing, so the same key runs it again.
1 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/operations/set_take_message_details" \ -H "Content-Type: application/json" \ -d '{ "agent": "string" }'{}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Set STT model POST
Set which speech-to-text engine transcribes the caller on this agent. The STT model is versioned, the write lands on the current draft version (create a draft first if the current version is published). Pass null to clear the override and fall back to the platform default. Unlike the LLM model this affects transcription accuracy, language coverage, and keyterm boosting support, call get_agent (sections: ['model']) first if unsure what's currently set.
Set message SMS copy POST
Give take_a_message a second way out: a mobile number that receives a short SMS copy of every message the agent takes, alongside the email. Use it when a business cannot afford to miss a message, the SMS does not travel through the recipient's mail server, so a spam filter or a full mailbox cannot swallow both copies. The email stays the primary channel and is unchanged. Pass an empty mobile to turn the text copy off. The change lands on the draft version.