Escopos e permissoes

As operações (read, insert, update, delete) que cada chave pode executar em cada recurso da API.

Cada chave carrega um conjunto de escopos: para cada recurso, as operações que ela pode executar. As operações são read (GET), insert (POST), update (PUT) e delete (DELETE).

Uma chave válida sem o escopo necessário recebe 403:

{ "errors": [{ "detail": "A chave de API não possui permissão para esta operação" }] }

Recursos, rotas e operações disponíveis

Escopo	Rotas	Operações disponíveis
leads	/v1/leads	read, insert, update, delete
companies	/v1/companies	read, insert, update
deals	/v1/deals	read, insert, update
deal_products	/v1/deals/{id}/products	read, insert, update, delete
tasks	/v1/tasks	read, insert, update
products	/v1/products	read, insert, update
sources	/v1/sources	read, insert, update
annotations	/v1/deals/{id}/annotations	read, insert
files	/v1/deals/{id}/files	read, insert, delete
proposals	/v1/deals/{id}/proposals	read, insert, update

A exclusão via API está disponível para contatos, produtos de negociação e arquivos.

Boa prática: conceda a cada integração apenas os escopos de que ela precisa. Os escopos de uma chave podem ser editados a qualquer momento no painel, sem trocar a chave.