{
"error": {
"code": "invalid_request",
"message": "prompt: prompt must not be blank",
"details": [
{
"path": "prompt",
"message": "prompt must not be blank"
}
]
}
}
{
"error": {
"code": "not_authenticated",
"message": "A valid API key is required."
}
}
The first message as written, with subject only when the sequence’s first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.
{
"error": {
"code": "invalid_request",
"message": "prompt: prompt must not be blank",
"details": [
{
"path": "prompt",
"message": "prompt must not be blank"
}
]
}
}
{
"error": {
"code": "not_authenticated",
"message": "A valid API key is required."
}
}
API key ret_live_… created in Settings → API keys.
Path Parameters
id
string
required
Id of the play.
leadId
string
required
Id of the lead.
Body
application/json
text
string
required
Maximum string length: 4000
subject
string
Maximum string length: 200
Response
The lead.
id
string
review_state
enum<string>
Available options:
review,
accepted,
rejected
person
object
Show child attributes
signal
object | null
Show child attributes
fit
string | null
in_sequence
boolean
first_message
object | null
Show child attributes
created_at
string<date-time>
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Retriever API","colors":{"primary":"#4F46E5"},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode","download-spec"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retriever-3987567e","hasAudioNarration":false,"actualSubdomain":"retriever-3987567e","customDomains":["docs.retriever.run"],"gitSource":{"type":"github","owner":"yonsy7","repo":"agentic-list-building","deployBranch":"master","contentDirectory":"docs/api/public","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afdd972374401a40709fe7c","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API reference","count":65},{"language":"default","tag":"Plays","count":24},{"language":"default","tag":"Guides","count":20},{"language":"default","tag":"Runs","count":9},{"language":"default","tag":"Scheduled runs","count":9},{"language":"default","tag":"Services","count":9},{"language":"default","tag":"Concepts","count":8},{"language":"default","tag":"Recipes","count":8},{"language":"default","tag":"Go","count":4},{"language":"default","tag":"Workspaces","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/plays/save-play-lead-message","slug":"/api-reference/plays/save-play-lead-message","pageMetadata":{"title":"Save a lead's message","description":"The first message as written, with `subject` only when the sequence's first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.","deprecated":null,"version":null,"sidebarTitle":"Save play lead message","openapi":"/openapi.yaml put /v1/plays/{id}/leads/{leadId}/message","href":"/api-reference/plays/save-play-lead-message","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"The first message as written, with \", _jsx(_components.code, {\n children: \"subject\"\n }), \" only when the sequence’s first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Save a lead's message","description":"The first message as written, with `subject` only when the sequence's first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.","deprecated":null,"version":null,"sidebarTitle":"Save play lead message","openapi":"/openapi.yaml put /v1/plays/{id}/leads/{leadId}/message","href":"/api-reference/plays/save-play-lead-message","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Plays"],"operationId":"savePlayLeadMessage","x-mint":{"href":"/api-reference/plays/save-play-lead-message"},"summary":"Save a lead's message","description":"The first message as written, with `subject` only when the sequence's first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.","parameters":["c7df811a-5f7d-46c2-b8a2-759136885bfd","ef17897f-bf7e-4ea9-a8fb-338acf603992"],"requestBody":"d3a17908-898b-4c6d-b171-ef719e522598","responses":{"200":"4ff66f52-66ec-4519-a3ee-7b24fc06057c","400":"151b632a-2000-4e87-97c4-2e4b836a55c7","401":"e1b01125-7af9-4250-b70d-e17020fbc7c0","404":"6c8a7831-e469-4585-8f16-a1cffdaa8031","409":"e5f597a7-a5ef-4957-bae6-44e3217bd506","415":"43c41390-fe4d-4504-901a-262edc4d895e","429":"d62108d8-ec9e-4bfa-b3b1-e5b70a9c91ab"},"method":"put","type":"path","servers":["c882335a-db3f-4621-bd34-32f09c9bda3d","f703bce9-6e01-42ea-a3fe-83bb79e3226c"],"security":["0f18c5fc-2ff7-4893-a504-8f4e321ffab5"],"path":"/v1/plays/{id}/leads/{leadId}/message","baseUrlOptions":["https://api.retriever.run","http://localhost:4320"],"title":"Save a lead's message","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"c7df811a-5f7d-46c2-b8a2-759136885bfd":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Id of the play.","uniqueKey":"","typeLabel":"string"},"description":"Id of the play."},"ef17897f-bf7e-4ea9-a8fb-338acf603992":{"name":"leadId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"Id of the lead.","uniqueKey":"","typeLabel":"string"},"description":"Id of the lead."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["text"],"additionalProperties":false,"properties":{"text":{"type":"string","maxLength":4000,"isRequired":true,"uniqueKey":"text","typeLabel":"string"},"subject":{"type":"string","maxLength":200,"uniqueKey":"subject","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"text":"\u003cstring>","subject":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4ff66f52-66ec-4519-a3ee-7b24fc06057c":{"description":"The lead.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"id","typeLabel":"string"},"review_state":{"type":"string","enum":["review","accepted","rejected"],"uniqueKey":"review_state","typeLabel":"enum\u003cstring>"},"person":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"person.name","typeLabel":"string"},"title":{"type":"string","uniqueKey":"person.title","typeLabel":"string"},"company":{"type":"string","uniqueKey":"person.company","typeLabel":"string"},"companyDomain":{"type":"string","uniqueKey":"person.companyDomain","typeLabel":"string"},"linkedinUrl":{"type":"string","uniqueKey":"person.linkedinUrl","typeLabel":"string"},"location":{"type":"string","uniqueKey":"person.location","typeLabel":"string"},"email":{"type":"string","uniqueKey":"person.email","typeLabel":"string"}},"uniqueKey":"person","typeLabel":"object"},"signal":{"oneOf":[{"type":"object","properties":{"summary":{"type":"string","uniqueKey":"signal.oneOf.0.summary","typeLabel":"string"},"source_url":{"oneOf":[{"type":"string","uniqueKey":"signal.oneOf.0.source_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"signal.oneOf.0.source_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"signal.oneOf.0.source_url","typeLabel":"string | null"}},"uniqueKey":"signal.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"summary":{"type":"string"},"source_url":{"oneOf":[{"type":"string"},{"type":"null"}]}},"uniqueKey":"signal.oneOf.1","typeLabel":"null"}],"uniqueKey":"signal","typeLabel":"object | null"},"fit":{"oneOf":[{"type":"string","uniqueKey":"fit.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"fit.oneOf.1","typeLabel":"null"}],"uniqueKey":"fit","typeLabel":"string | null"},"in_sequence":{"type":"boolean","uniqueKey":"in_sequence","typeLabel":"boolean"},"first_message":{"oneOf":[{"type":"object","properties":{"subject":{"oneOf":[{"type":"string","uniqueKey":"first_message.oneOf.0.subject.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"first_message.oneOf.0.subject.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_message.oneOf.0.subject","typeLabel":"string | null"},"text":{"type":"string","uniqueKey":"first_message.oneOf.0.text","typeLabel":"string"},"edited_by_user":{"type":"boolean","uniqueKey":"first_message.oneOf.0.edited_by_user","typeLabel":"boolean"}},"uniqueKey":"first_message.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"subject":{"oneOf":[{"type":"string"},{"type":"null"}]},"text":{"type":"string"},"edited_by_user":{"type":"boolean"}},"uniqueKey":"first_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"first_message","typeLabel":"object | null"},"created_at":{"type":"string","format":"date-time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","review_state":"review","person":{"name":"\u003cstring>","title":"\u003cstring>","company":"\u003cstring>","companyDomain":"\u003cstring>","linkedinUrl":"\u003cstring>","location":"\u003cstring>","email":"\u003cstring>"},"signal":{"summary":"\u003cstring>","source_url":"\u003cstring>"},"fit":"\u003cstring>","in_sequence":true,"first_message":{"subject":"\u003cstring>","text":"\u003cstring>","edited_by_user":true},"created_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"151b632a-2000-4e87-97c4-2e4b836a55c7":{"description":"`invalid_request`: unreadable JSON, unknown field or query parameter, wrong type, `limit` out of range, empty `Idempotency-Key`, invalid `output` contract. `message` names each invalid field; `details` lists them as `{ path, message }`. On `POST /v1/runs`, `workspace_mismatch`: the conversation does not belong to the provided workspace.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_request","message":"prompt: prompt must not be blank","details":[{"path":"prompt","message":"prompt must not be blank"}]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"prompt: prompt must not be blank","details":[{"path":"prompt","message":"prompt must not be blank"}]}}}},"exampleType":"examples"}},"exampleType":"examples"},"e1b01125-7af9-4250-b70d-e17020fbc7c0":{"description":"`not_authenticated`: missing header, malformed (expected `Bearer \u003ckey>`), revoked or unknown key.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_authenticated","message":"A valid API key is required."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_authenticated","message":"A valid API key is required."}}}},"exampleType":"examples"}},"exampleType":"examples"},"6c8a7831-e469-4585-8f16-a1cffdaa8031":{"description":"`play_not_found`: unknown id or another organization's play. `play_lead_not_found`. `play_update_not_found`: unknown proposal.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"e5f597a7-a5ef-4957-bae6-44e3217bd506":{"description":"`play_archived`: restore it first. `play_not_launched`: launch it first. `play_lead_decided`: the lead was already kept or rejected. `play_update_stale`, `play_update_decided`, `play_update_not_applicable`: about a proposal. `play_message_edited_by_hand`: the message was edited by hand in its sequence. `play_message_not_synced`: the sequence did not take the message (its step already left). `play_run_busy`: a run of the play is waiting or going. `play_paused`: resume it first. `scheduled_run_archived`: the play was archived meanwhile. `company_icp_brief_not_found`: a new channel gets its steps written from the Brain, and the organization has none. `play_version_moved`: another change was saved on the play at the same moment; read it again and retry.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"43c41390-fe4d-4504-901a-262edc4d895e":{"description":"`invalid_request`: add `Content-Type: application/json`.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_request","message":"Content-Type must be application/json."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_request","message":"Content-Type must be application/json."}}}},"exampleType":"examples"}},"exampleType":"examples"},"d62108d8-ec9e-4bfa-b3b1-e5b70a9c91ab":{"description":"`rate_limited`: wait `Retry-After` seconds, then retry.","headers":{"Retry-After":{"schema":{"type":"integer"}},"RateLimit-Limit":{"schema":{"type":"integer"},"description":"Window budget."},"RateLimit-Remaining":{"schema":{"type":"integer"},"description":"Remaining requests."},"RateLimit-Reset":{"schema":{"type":"integer"},"description":"Seconds until reset."}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Stable code; use in your application.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation. May change.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Optional details (e.g. list of invalid fields).","uniqueKey":"error.details","typeLabel":"any"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limited","message":"Rate limit exceeded. Retry in 12 s."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limited","message":"Rate limit exceeded. Retry in 12 s."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"0f18c5fc-2ff7-4893-a504-8f4e321ffab5":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key `ret_live_…` created in Settings → API keys.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"c882335a-db3f-4621-bd34-32f09c9bda3d":{"url":"https://api.retriever.run","description":"Production"},"f703bce9-6e01-42ea-a3fe-83bb79e3226c":{"url":"http://localhost:4320","description":"Local app-server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key `ret_live_…` created in Settings → API keys.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key `ret_live_…` created in Settings → API keys.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"retriever-3987567e","siteName":"Retriever API","title":"Save a lead's message - Retriever API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T16:59:35.393Z","originalFileLocation":"api-reference/plays/save-play-lead-message.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"The first message as written, with subject only when the sequence\u0026#x27;s first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Retriever API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Save a lead\u0026#x27;s message - Retriever API\">\u003cmeta data-mint-head property=\"og:description\" content=\"The first message as written, with subject only when the sequence\u0026#x27;s first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Retriever API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retriever.run/api-reference/plays/save-play-lead-message\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://retriever-3987567e.mintlify.site/_mintlify/api/og/v2?division=Plays\u0026amp;title=Save+a+lead%27s+message\u0026amp;description=The+first+message+as+written%2C+with+%60subject%60+only+when+the+sequence%27s+first+message+is+an+email.+Once+the+lead+is+in+its+sequence%2C+a+message+that+fits+that+step\u0026amp;theme=a047e1d91cee8a1dafee7367\u0026amp;signature=0694aa282131363f4e9b132316edaaec5a98e840f09b6b63fea19376e62524d8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Save a lead\u0026#x27;s message - Retriever API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The first message as written, with subject only when the sequence\u0026#x27;s first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://retriever-3987567e.mintlify.site/_mintlify/api/og/v2?division=Plays\u0026amp;title=Save+a+lead%27s+message\u0026amp;description=The+first+message+as+written%2C+with+%60subject%60+only+when+the+sequence%27s+first+message+is+an+email.+Once+the+lead+is+in+its+sequence%2C+a+message+that+fits+that+step\u0026amp;theme=a047e1d91cee8a1dafee7367\u0026amp;signature=0694aa282131363f4e9b132316edaaec5a98e840f09b6b63fea19376e62524d8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"https://mintlify.s3.us-west-1.amazonaws.com/retriever-3987567e/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Retriever API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4F46E5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retriever.run/api-reference/plays/save-play-lead-message\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/plays/save-play-lead-message.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.retriever.run/#organization\",\"name\":\"Retriever API\",\"url\":\"https://docs.retriever.run\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.retriever.run#website\",\"name\":\"Retriever API\",\"url\":\"https://docs.retriever.run\",\"publisher\":{\"@id\":\"https://docs.retriever.run/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message#webpage\",\"url\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message\",\"name\":\"Save a lead's message\",\"description\":\"The first message as written, with subject only when the sequence's first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\",\"dateModified\":\"2026-11-18T16:59:35.393Z\",\"isPartOf\":{\"@id\":\"https://docs.retriever.run#website\"},\"breadcrumb\":{\"@id\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Plays\",\"item\":\"https://docs.retriever.run/api-reference/plays/list-plays\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Save a lead's message\",\"item\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message#apireference\",\"headline\":\"Save a lead's message\",\"name\":\"Save a lead's message\",\"description\":\"The first message as written, with subject only when the sequence's first message is an email. Once the lead is in its sequence, a message that fits that step is the one it sends; one that does not fit stays on the lead only.\",\"url\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message\",\"mainEntityOfPage\":{\"@id\":\"https://docs.retriever.run/api-reference/plays/save-play-lead-message#webpage\"},\"dateModified\":\"2026-11-18T16:59:35.393Z\",\"publisher\":{\"@id\":\"https://docs.retriever.run/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.retriever.run#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Retriever API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Retriever API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/plays/save-play-lead-message.md","siteName":"Retriever API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Runs","pages":[{"title":"List runs","deprecated":null,"version":null,"sidebarTitle":"List runs","openapi":"/openapi.yaml get /v1/runs","href":"/api-reference/runs/list-runs"},{"title":"Start a run","deprecated":null,"version":null,"sidebarTitle":"Create run","openapi":"/openapi.yaml post /v1/runs","href":"/api-reference/runs/create-run"},{"title":"Get run status","deprecated":null,"version":null,"sidebarTitle":"Get run","openapi":"/openapi.yaml get /v1/runs/{id}","href":"/api-reference/runs/get-run"},{"title":"Request cancellation","deprecated":null,"version":null,"sidebarTitle":"Cancel run","openapi":"/openapi.yaml post /v1/runs/{id}/cancel","href":"/api-reference/runs/cancel-run"},{"title":"Get published output","deprecated":null,"version":null,"sidebarTitle":"Get run output","openapi":"/openapi.yaml get /v1/runs/{id}/output","href":"/api-reference/runs/get-run-output"},{"title":"Frozen table metadata","deprecated":null,"version":null,"sidebarTitle":"Get output table","openapi":"/openapi.yaml get /v1/runs/{id}/output/tables/{key}","href":"/api-reference/runs/get-output-table"},{"title":"Frozen table rows","deprecated":null,"version":null,"sidebarTitle":"List output table rows","openapi":"/openapi.yaml get /v1/runs/{id}/output/tables/{key}/rows","href":"/api-reference/runs/list-output-table-rows"},{"title":"Create a CSV or JSON export of a frozen table","deprecated":null,"version":null,"sidebarTitle":"Create export","openapi":"/openapi.yaml post /v1/runs/{id}/exports","href":"/api-reference/runs/create-export"},{"title":"Download an export","deprecated":null,"version":null,"sidebarTitle":"Download export","openapi":"/openapi.yaml get /v1/runs/{id}/exports/{exportId}","href":"/api-reference/runs/download-export"}]},{"group":"Tables","pages":[{"title":"Live table metadata","deprecated":null,"version":null,"sidebarTitle":"Get table","openapi":"/openapi.yaml get /v1/tables/{id}","href":"/api-reference/tables/get-table"},{"title":"Live table rows","deprecated":null,"version":null,"sidebarTitle":"List table rows","openapi":"/openapi.yaml get /v1/tables/{id}/rows","href":"/api-reference/tables/list-table-rows"}]},{"group":"Workspaces","pages":[{"title":"List workspaces","deprecated":null,"version":null,"sidebarTitle":"List workspaces","openapi":"/openapi.yaml get /v1/workspaces","href":"/api-reference/workspaces/list-workspaces"},{"title":"Create a workspace","deprecated":null,"version":null,"sidebarTitle":"Create workspace","openapi":"/openapi.yaml post /v1/workspaces","href":"/api-reference/workspaces/create-workspace"},{"title":"List non-archived tables","deprecated":null,"version":null,"sidebarTitle":"List workspace tables","openapi":"/openapi.yaml get /v1/workspaces/{id}/tables","href":"/api-reference/workspaces/list-workspace-tables"},{"title":"Import a table (columns + JSON rows)","deprecated":null,"version":null,"sidebarTitle":"Import table","openapi":"/openapi.yaml post /v1/workspaces/{id}/tables","href":"/api-reference/workspaces/import-table"}]},{"group":"Exclusions","pages":[{"title":"List an exclusion list","deprecated":null,"version":null,"sidebarTitle":"List exclusions","openapi":"/openapi.yaml get /v1/exclusions/{kind}","href":"/api-reference/exclusions/list-exclusions"},{"title":"Add values (upsert)","deprecated":null,"version":null,"sidebarTitle":"Add exclusions","openapi":"/openapi.yaml post /v1/exclusions/{kind}","href":"/api-reference/exclusions/add-exclusions"},{"title":"Remove values","deprecated":null,"version":null,"sidebarTitle":"Remove exclusions","openapi":"/openapi.yaml post /v1/exclusions/{kind}/remove","href":"/api-reference/exclusions/remove-exclusions"}]},{"group":"Scheduled runs","pages":[{"title":"List scheduled runs","deprecated":null,"version":null,"sidebarTitle":"List scheduled runs","openapi":"/openapi.yaml get /v1/scheduled-runs","href":"/api-reference/scheduled-runs/list-scheduled-runs"},{"title":"Create a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Create scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs","href":"/api-reference/scheduled-runs/create-scheduled-run"},{"title":"Read a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Get scheduled run","openapi":"/openapi.yaml get /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/get-scheduled-run"},{"title":"Delete a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Delete scheduled run","openapi":"/openapi.yaml delete /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/delete-scheduled-run"},{"title":"Change a scheduled run","deprecated":null,"version":null,"sidebarTitle":"Update scheduled run","openapi":"/openapi.yaml patch /v1/scheduled-runs/{id}","href":"/api-reference/scheduled-runs/update-scheduled-run"},{"title":"Start the cadence","deprecated":null,"version":null,"sidebarTitle":"Activate scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/activate","href":"/api-reference/scheduled-runs/activate-scheduled-run"},{"title":"Stop the cadence","deprecated":null,"version":null,"sidebarTitle":"Pause scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/pause","href":"/api-reference/scheduled-runs/pause-scheduled-run"},{"title":"Start an execution now","deprecated":null,"version":null,"sidebarTitle":"Run scheduled run","openapi":"/openapi.yaml post /v1/scheduled-runs/{id}/run","href":"/api-reference/scheduled-runs/run-scheduled-run"},{"title":"List executions","deprecated":null,"version":null,"sidebarTitle":"List scheduled run executions","openapi":"/openapi.yaml get /v1/scheduled-runs/{id}/runs","href":"/api-reference/scheduled-runs/list-scheduled-run-executions"}]},{"group":"Plays","pages":[{"title":"List plays","deprecated":null,"version":null,"sidebarTitle":"List plays","openapi":"/openapi.yaml get /v1/plays","href":"/api-reference/plays/list-plays"},{"title":"Create a play","deprecated":null,"version":null,"sidebarTitle":"Create play","openapi":"/openapi.yaml post /v1/plays","href":"/api-reference/plays/create-play"},{"title":"What is new across plays","deprecated":null,"version":null,"sidebarTitle":"List play news","openapi":"/openapi.yaml get /v1/plays/news","href":"/api-reference/plays/list-play-news"},{"title":"Read a play","deprecated":null,"version":null,"sidebarTitle":"Get play","openapi":"/openapi.yaml get /v1/plays/{id}","href":"/api-reference/plays/get-play"},{"title":"Delete a play","deprecated":null,"version":null,"sidebarTitle":"Delete play","openapi":"/openapi.yaml delete /v1/plays/{id}","href":"/api-reference/plays/delete-play"},{"title":"Change a play","deprecated":null,"version":null,"sidebarTitle":"Update play","openapi":"/openapi.yaml patch /v1/plays/{id}","href":"/api-reference/plays/update-play"},{"title":"List a play's versions","deprecated":null,"version":null,"sidebarTitle":"List play versions","openapi":"/openapi.yaml get /v1/plays/{id}/versions","href":"/api-reference/plays/list-play-versions"},{"title":"Restore a play version","deprecated":null,"version":null,"sidebarTitle":"Restore play version","openapi":"/openapi.yaml post /v1/plays/{id}/versions/{version}/restore","href":"/api-reference/plays/restore-play-version"},{"title":"Launch a play","deprecated":null,"version":null,"sidebarTitle":"Launch play","openapi":"/openapi.yaml post /v1/plays/{id}/launch","href":"/api-reference/plays/launch-play"},{"title":"Pause a play","deprecated":null,"version":null,"sidebarTitle":"Pause play","openapi":"/openapi.yaml post /v1/plays/{id}/pause","href":"/api-reference/plays/pause-play"},{"title":"Run a play now","deprecated":null,"version":null,"sidebarTitle":"Run play now","openapi":"/openapi.yaml post /v1/plays/{id}/run","href":"/api-reference/plays/run-play-now"},{"title":"Resume a play","deprecated":null,"version":null,"sidebarTitle":"Resume play","openapi":"/openapi.yaml post /v1/plays/{id}/resume","href":"/api-reference/plays/resume-play"},{"title":"Archive a play","deprecated":null,"version":null,"sidebarTitle":"Archive play","openapi":"/openapi.yaml post /v1/plays/{id}/archive","href":"/api-reference/plays/archive-play"},{"title":"Restore a play","deprecated":null,"version":null,"sidebarTitle":"Restore play","openapi":"/openapi.yaml post /v1/plays/{id}/restore","href":"/api-reference/plays/restore-play"},{"title":"List a play's leads","deprecated":null,"version":null,"sidebarTitle":"List play leads","openapi":"/openapi.yaml get /v1/plays/{id}/leads","href":"/api-reference/plays/list-play-leads"},{"title":"Keep a lead","deprecated":null,"version":null,"sidebarTitle":"Accept play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/accept","href":"/api-reference/plays/accept-play-lead"},{"title":"Reject a lead","deprecated":null,"version":null,"sidebarTitle":"Reject play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/reject","href":"/api-reference/plays/reject-play-lead"},{"title":"Find someone else","deprecated":null,"version":null,"sidebarTitle":"Replace play lead","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/replace","href":"/api-reference/plays/replace-play-lead"},{"title":"Rewrite a lead's message","description":"A model writes the first message again, as `instructions` asks. A message edited by hand in the sequence answers `409 play_message_edited_by_hand` unless `overwrite_hand_edit` is true. `voice_rule_added`: a rule the request added to the organization's voice, or null.","deprecated":null,"version":null,"sidebarTitle":"Rewrite play lead message","openapi":"/openapi.yaml post /v1/plays/{id}/leads/{leadId}/message/rewrite","href":"/api-reference/plays/rewrite-play-lead-message"},{"title":"Save a lead's message","deprecated":null,"version":null,"sidebarTitle":"Save play lead message","openapi":"/openapi.yaml put /v1/plays/{id}/leads/{leadId}/message","href":"/api-reference/plays/save-play-lead-message"},{"title":"Rewrite the steps' instructions","description":"A model rewrites the writing instructions of the sequence's steps as `request` asks, for every next message. A new version.","deprecated":null,"version":null,"sidebarTitle":"Rewrite play step instructions","openapi":"/openapi.yaml post /v1/plays/{id}/steps/rewrite","href":"/api-reference/plays/rewrite-play-step-instructions"},{"title":"Move leads to the play's channel","deprecated":null,"version":null,"sidebarTitle":"Move play leads","openapi":"/openapi.yaml post /v1/plays/{id}/leads/move","href":"/api-reference/plays/move-play-leads"},{"title":"Apply a proposal","deprecated":null,"version":null,"sidebarTitle":"Apply play proposal","openapi":"/openapi.yaml post /v1/plays/{id}/proposals/{proposalId}/apply","href":"/api-reference/plays/apply-play-proposal"},{"title":"Dismiss a proposal","deprecated":null,"version":null,"sidebarTitle":"Dismiss play proposal","openapi":"/openapi.yaml post /v1/plays/{id}/proposals/{proposalId}/dismiss","href":"/api-reference/plays/dismiss-play-proposal"}]},{"group":"Go","pages":[{"title":"Synchronous structured research","deprecated":null,"version":null,"sidebarTitle":"Run sync","openapi":"/openapi.yaml post /v1/go/run","href":"/api-reference/go/run-sync"},{"title":"Asynchronous structured research","deprecated":null,"version":null,"sidebarTitle":"Create go run","openapi":"/openapi.yaml post /v1/go/runs","href":"/api-reference/go/create-go-run"},{"title":"Go job status","deprecated":null,"version":null,"sidebarTitle":"Get go run","openapi":"/openapi.yaml get /v1/go/runs/{id}","href":"/api-reference/go/get-go-run"},{"title":"Cancel a Go job","deprecated":null,"version":null,"sidebarTitle":"Cancel go run","openapi":"/openapi.yaml post /v1/go/runs/{id}/cancel","href":"/api-reference/go/cancel-go-run"}]},{"group":"Services","pages":[{"title":"Discover services","deprecated":null,"version":null,"sidebarTitle":"List services","openapi":"/openapi.yaml get /services","href":"/api-reference/services/list-services"},{"title":"Describe a service (input schema, cost)","deprecated":null,"version":null,"sidebarTitle":"Get service","openapi":"/openapi.yaml get /services/{serviceName}","href":"/api-reference/services/get-service"},{"title":"Execute a service","deprecated":null,"version":null,"sidebarTitle":"Execute service","openapi":"/openapi.yaml post /services/{serviceName}","href":"/api-reference/services/execute-service"},{"title":"List your service jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs","href":"/api-reference/services/list-your-service-jobs"},{"title":"Removed, send a list","deprecated":true,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs","href":"/api-reference/services/removed-send-a-list"},{"title":"Service job status and result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs/{id}","href":"/api-reference/services/service-job-status-and-result"},{"title":"Cancel a service job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/{id}/cancel","href":"/api-reference/services/cancel-a-service-job"},{"title":"Run a slow service (a list of 1 to 100 inputs)","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/services/jobs/batch","href":"/api-reference/services/run-a-slow-service-a-list-of-1-to-100-inputs"},{"title":"Batch status and results","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/services/jobs/batch/{id}","href":"/api-reference/services/batch-status-and-results"}]},{"group":"Credits","pages":[{"title":"Credit balance","deprecated":null,"version":null,"sidebarTitle":"Get credits","openapi":"/openapi.yaml get /credits","href":"/api-reference/credits/get-credits"}]}]}]},"basePath":"","title":"Save a lead's message - Retriever API","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}