Caro cliente, informamos que à partir do dia 16 de novembro de 2021, a estrutura da API do PipeRun passará por alterações. Portanto, os clientes terão até esta data para atualizarem suas integrações e se adaptarem as mudanças, para que nenhuma delas deixe de funcionar.
Endpoints que passarão por alterações:
- Atividades
- Empresas
- Pessoas
- Oportunidades
- Arquivos
- Usuários
ENDPOINT DE ATIVIDADES:
No endpoint de atividades o seguinte campo de relação (parâmetro with) será adicionado:
| city |
Os seguintes campos de relações serão modificados e também não virão mais como padrão (ou seja, será necessário utilizar o parâmetro with na requisição para trazer a relação):
| Original: | Mudou para: |
| companies | company |
| contact_emails | contactEmails |
| contact_phones | contactPhones |
| custom_fields | customFields |
O seguinte campo de relação não virá mais como padrão (ou seja, será necessário utilizar o parâmetro with na requisição para trazer a relação):
| persons |
Além disso, os seguintes campos foram removidos:
| google_calendar_id |
| outlook_calendar_id |
| project_id |
| activity_type |
| working |
Exemplo de response:
GET https://api.pipe.run/v1/activities?with=persons.customFields
ENDPOINT DE EMPRESAS:
No endpoint de empresas o seguinte campo de relação (parâmetro with) será adicionado:
| city |
Os seguintes campos de relações serão modificados e também não virão mais como padrão (ou seja, será necessário utilizar o parâmetro with na requisição para trazer a relação):
| Original: | Mudou para: |
| contact_emails | contactEmails |
| contact_phones | contactPhones |
| custom_fields | customFields |
ENDPOINT DE PESSOAS:
No endpoint de pessoas os seguintes campos de relação (parâmetro with) serão adicionados:
| city |
| company |
Os seguintes campos de relações serão modificados e não virão mais como padrão (ou seja, será necessário utilizar o parâmetro with na requisição para trazer a relação):
| Original: | Mudou para: |
| contact_emails | contactEmails |
| contact_phones | contactPhones |
| custom_fields | customFields |
Exemplo de response:
GET https://api.pipe.run/v1/persons para GET https://api.pipe.run/v1/v1/persons?with=contactPhones
ENDPOINT DE OPORTUNIDADES:
No endpoint de oportunidades (deals), o seguinte campo foi alterado:
| Original: | Mudou para: |
| data_congelamento | frozen_at |
ENDPOINT DE ARQUIVOS:
No endpoint de arquivos (files), o seguinte campo foi removido:
| project_id |
ENDPOINT DE USUÁRIOS:
No endpoint de usuários (users), o seguinte campo foi removido:
| external_created_at |
Em caso de dúvidas, entre em contato com nossa equipe de suporte.
Você também pode conferir a documentação da API neste link.