Pular para o conteúdo

GET /v1/pipelines/stages/{stageId}/playbook

GET
/v1/pipelines/stages/{stageId}/playbook
curl --request GET \
--url https://seu-endereco-da-api/v1/pipelines/stages/example/playbook \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Editar roteiro de vendas e objeções (sales-playbook:manage), ou Gerenciar pipelines (pipelines:manage).

stageId
required
string
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
nullable
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
nullable
Allowed values: disabled daily_cap no_credit
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
nullable
learnsFromWonDeals
required

Whether the account allowed reading its conversations, which the AI needs to propose improvements from won deals

boolean

Example

{
"proposal": {
"blocked": "disabled"
}
}