Pular para o conteúdo

PUT /v1/conversations/{id}/sales-checklist/marks

PUT
/v1/conversations/{id}/sales-checklist/marks
curl --request PUT \
--url https://seu-endereco-da-api/v1/conversations/example/sales-checklist/marks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "item": "example", "done": true }'

Permissão que a Chave de acesso precisa: Enviar mensagem e atender (conversations:write).

id
required
string
Media typeapplication/json
object
item
required

The step text, exactly as in the checklist of the stage

string
>= 1 characters <= 1000 characters
done
required
boolean

Example generated

{
"item": "example",
"done": true
}
Media typeapplication/json
object
hasOpenDeal
required

Whether the conversation has an open deal; without one the checklist is the generic sales method

boolean
dealId
required
string
nullable
stageId
required

Stage the checklist belongs to; marks are kept per stage

string
nullable
checklist
required
object
source
required

Generic when the sales playbook has no checklist for this stage

string
Allowed values: playbook generic
stageName
required
string
nullable
items
required
Array<string>
items
required

The checklist with what a person marked by hand over what the AI marked

Array<object>
object
text
required
string
done
required
boolean
markedBy
required

Who marked the step done: the AI or a person; null when it is still missing

string
nullable
Allowed values: ai person

Example

{
"checklist": {
"source": "playbook"
},
"items": [
{
"markedBy": "ai"
}
]
}

The step is not in the checklist of the stage

The conversation is with another agent or was not accepted yet