PUT /v1/pipelines/stages/{stageId}/playbook
PUT
/v1/pipelines/stages/{stageId}/playbook
const url = 'https://seu-endereco-da-api/v1/pipelines/stages/example/playbook';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"questions":["example"],"checklist":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://seu-endereco-da-api/v1/pipelines/stages/example/playbook \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "questions": [ "example" ], "checklist": [ "example" ] }'Permissão que a Chave de acesso precisa: Editar roteiro de vendas e objeções (sales-playbook:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”stageId
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
questions
required
Array<string>
checklist
required
Array<string>
Example generated
{ "questions": [ "example" ], "checklist": [ "example" ]}Responses
Seção intitulada “Responses”Media typeapplication/json
object
stage
required
Null when the sales playbook has no entry for this stage
object
name
required
string
pipelineStageId
required
The funnel stage this checklist belongs to; null when it is not tied to one
string format: uuid
questions
required
Array<string>
checklist
required
Empty means the stage uses the generic sales method
Array<string>
proposal
required
What the AI proposed for this stage, waiting for the owner to save the stage; gone once the stage entry is saved
object
questions
required
Array<string>
checklist
required
Array<string>
blocked
required
Why the AI wrote nothing; the lists are empty when set
string
wonDealQuote
required
A line from a won sale’s conversation that shows the improvement; set when the AI proposed items read from won deals, null when it wrote a new stage
string
learnsFromWonDeals
required
Whether the account allowed reading its conversations, which the AI needs to propose improvements from won deals
boolean
Example
{ "proposal": { "blocked": "disabled" }}