/

Docs
History
Schema
Generate

Filter operations

get/filesListar arquivos
get/files/{file_id}Ver detalhes do arquivo
delete/files/{file_id}Deletar arquivo
get/activitiesListar atividades
post/activitiesAdicionar atividade
get/activities/{id}Buscar atividade
put/activities/{id}Atualizar atividade
delete/activities/{id}Deletar atividade
get/activityTypesListar tipos de atividade
post/activityTypesAdicionar tipo de atividade
get/activityTypes/{id}Ver detalhes do tipo da atividade
put/activityTypes/{id}Atualizar tipo de atividade
delete/activityType/{id}Deletar tipo de atividade
get/customFieldsListar campos customizados
post/customFieldsAdicionar campos customizados
get/customFields/{id}Ver detalhes do campo customizado
put/customFields/{id}Atualizar campo customizado
delete/customFields/{id}Deletar campo customizado
get/citiesCidades
get/cities/{id}Ver detalhes da cidade
get/cnaesCNAES
put/emails/readMarcar e-mail como lido
put/emails/unreadMarcar e-mail como não lido
put/emails/archiveArquivar e-mail
put/emails/inboxMover e-mail para caixa de entrada
delete/emails/deleteBulkDeletar e-mail
get/emailsListar e-mails
get/email/templatesListar templates de e-mail
post/email/templatesCriar template de e-mail
get/email/template/{email_template_id}Ver detalhes do template de e-mail
put/email/template/{email_template_id}Atualizar template de e-mail
delete/email/template/{email_template_id}Deletar template de e-mail
get/companiesListar empresas
post/companiesAdicionar empresa
get/companies/{id}Ver detalhes da empresa
put/companies/{id}Atualizar empresa
delete/companies/{id}Deletar empresa
get/segmentsListar segmentos
post/segmentsAdicionar segmentos
get/segments/{segment_id}Ver detalhes do segmento
put/segments/{segment_id}Atualizar segmento
delete/segments/{segment_id}Deletar segmento
get/companies/custom-fieldsCampos customizados em empresas
get/customFormsListar formulários customizados
post/customFormsAdicionar formulário customizado
get/customForms/{id}Ver detalhes do formulário customizado
put/customForms/{id}Atualizar formulário customizado
delete/customForms/{id}Deletar formulário customizado
get/pipelinesListar funis
post/pipelinesAdicionar funil
get/pipelines/{id}Buscar funil
put/pipelines/{id}Atualizar funil
delete/pipelines/{id}Deletar funil
get/stageHistoriesListar histórico de etapas de funil
get/stagesListar etapas de funil
post/stagesAdicionar etapa de funil
get/stages/{stage_id}Ver detalhes da etapa de funil
put/stages/{stage_id}Atualizar etapa de funil
delete/stages/{stage_id}Deletar etapa de funil
get/callsListar histórico de ligações
post/callsAdicionar histórico de ligação
get/calls/{call_id}Ver detalhes do histórico de ligação
put/calls/{call_id}Atualizar histórico de ligação
delete/calls/{call_id}Deletar histórico de ligação
get/itemsListar itens
post/itemsAdicionar item
get/items/{item_id}Ver detalhes do item
put/items/{item_id}Atualizar item
delete/items/{item_id}Deletar item
get/items/characteristicsListar características dos itens
post/items/characteristicsAdicionar característica do item
get/items/characteristics/{item_characteristics_id}Ver detalhes da característica do item
put/items/characteristics/{item_characteristics_id}Atualizar característica do item
delete/items/characteristics/{item_characteristics_id}Deletar característica do item
post/items/characteristics/{char_id}/optionsAdicionar opções na característica do item
get/itemCategoriesListar categorias de item
post/itemCategoriesAdicionar categoria de item
get/itemCategories/{item_categories_id}Ver detalhes da categoria de item
put/itemCategories/{item_categories_id}Atualizar categoria de item
delete/itemCategories/{item_categories_id}Deletar categoria de item
get/datalistsListar listas de dados
post/datalistsAdicionar lista de dados
get/datalists/{id}Ver detalhes da lista de dados
put/datalists/{id}Atualizar lista de dados
delete/datalists/{id}Deletar lista de dados
get/datalists/{id}/fieldsListar campos de uma lista de dados
post/datalists/{id}/fieldsAdicionar campo em uma lista de dados
put/datalists/{datalist_id}/fields/{id}Atualizar campo em uma lista de dados
delete/datalists/{datalist_id}/fields/{id}Deletar campo em uma lista de dados
get/datalists/{datalist_id}/fields/{id}/optionsListar opções de um campo de lista de dados
post/datalists/{datalist_id}/fields/{id}/optionsAdicionar opções em um campo de lista de dados
put/datalists/{datalist_id}/fields/{field_id}/options/{id}Atualizar opções em um campo de lista de dados
delete/datalists/{datalist_id}/fields/{id}/options/{id}Deletar opção de um campo de lista de dados
get/datalists/{id}/recordsListar registros de uma lista de dados
post/datalists/{id}/recordsAdicionar registro sem vínculo à lista de dados
get/datalists/{datalist_id}/records/{record_id}Ver detalhes do registro da lista de dados
put/datalists/{datalist_id}/records/{record_id}Atualizar registro de uma lista de dados
delete/datalists/{datalist_id}/records/{record_id}Deletar registro da lista de dados
get/deals/{deal_id}/datalists/{datalist_id}/recordsListar registros da oportunidade
post/deals/{deal_id}/datalists/{datalist_id}/recordsAdicionar registro na oportunidade
get/deals/requiredFieldRulesListar regras de preenchimento de campos

Changes to Listar regras de preenchimento de campos

get/deals/requiredFieldRules

Nov 3, 2026cdfaac104426 Revision changes
- info
  endpoint deprecated