GET /v1/sales-playbook
GET
/v1/sales-playbook
const url = 'https://seu-endereco-da-api/v1/sales-playbook';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/sales-playbook \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler conversas (conversations:read), ou Ler negócios (deals:read), ou Editar roteiro de vendas e objeções (sales-playbook:manage).
Authorizations
Seção intitulada “Authorizations”Responses
Seção intitulada “Responses”Media typeapplication/json
object
playbook
required
object
stages
required
Array<object>
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>
objections
required
Array<object>
object
objection
required
string
answer
required
string
quotes
required
What customers actually wrote, read from the account’s conversations when the owner allowed it
Array<string>
Example generated
{ "playbook": { "stages": [ { "name": "example", "pipelineStageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "questions": [ "example" ], "checklist": [ "example" ] } ], "objections": [ { "objection": "example", "answer": "example", "quotes": [ "example" ] } ] }}