A partir de 10/03/2025 será realizada uma mudança na rota de edição de oportunidades na nossa API.
Essa alteração afeta a forma como as tags são retornadas no endpoint de edição de oportunidade. A partir desta alteração , as tags não serão mais incluídas automaticamente na resposta da edição.
Para evitar problemas de integração e garantir que as informações de tags continuem disponíveis ao editar oportunidades, certifique-se de atualizar suas chamadas de API, adicionando o parâmetro ?with=tags (ou ?with=tags,customFields caso também precise dos campos personalizados).
Confira neste artigo o que mudou e como você deve configurar o Json para que as integrações ocorram sem falhas.
TÓPICOS DO ARTIGO
QUAL FOI A MUDANÇA?
- Antes da mudança: Ao editar uma oportunidade, a resposta já incluía as tags vinculadas àquela oportunidade.
- Depois da mudança: Agora, por padrão, as tags não serão retornadas. Para obtê-las, será necessário adicionar o parâmetro
?with=tagsna chamada à rota de edição.
QUAL O IMPACTO PARA AS INTEGRAÇOES VIA API?
- Quem será impactado? Todos os clientes e desenvolvedores que utilizam a rota de edição de oportunidade e esperam receber as tags automaticamente no JSON de retorno.
- O que acontece se não adaptar? Caso o parâmetro
?with=tagsnão seja adicionado, as tags não serão mais exibidas no response, o que pode impactar funcionalidades ou fluxos que dependem dessas informações.
O QUE DEVO FAZER?
Para continuar recebendo as tags ao editar oportunidades, é necessário incluir o parâmetro ?with=tags na URL. Exemplo de chamada:
PUT /oportunidades/{id}?with=tagsSe você também deseja receber campos personalizados (customFields) no mesmo retorno, basta acrescentar customFields:
PUT /oportunidades/{id}?with=tags,customFieldsEXEMPLO DO JSON ANTES DO AJUSTE
No exemplo abaixo, as tags eram retornadas automaticamente na edição, sem a necessidade de incluir o parâmetro ?with=tags:
{
"success": true,
"message": "OK",
"data": {
"id": 33212219,
"hash": "at91up5t9kw0oowswcsgs8408og4cc8",
"rdstation_reference": null,
"data_congelamento": null,
"type_reference": null,
"reference": null,
"temperature": null,
"probability": null,
"deleted_at": null,
"account_id": 3873,
"pipeline_id": 82119,
"owner_id": 33059,
"stage_id": 515165,
"person_id": null,
"company_id": null,
"lost_reason_id": null,
"origin_id": null,
"started_in_stage_id": 515165,
"created_at": "2024-12-10 17:38:40",
"title": "cf feldens alterado json response",
"description": null,
"observation": null,
"status": 0,
"closed_at": null,
"reason_close": null,
"deleted": 0,
"freezed": 0,
"value": "0.00",
"order": 6,
"updated_at": "2025-01-09 14:31:06",
"last_stage_updated_at": "2025-01-09 14:31:06",
"value_mrr": "0.00",
"probably_closed_at": null,
"last_contact_at": null,
"stage_changed_at": null,
"tags": [
{
"id": 273265,
"active": true,
"deleted_at": null,
"account_id": 3873,
"user_id": 33059,
"name": "[base] converteram | startup summit online 2023 | 24.07.23",
"color": "danger",
"created_at": "2023-07-24T17:53:57.000000Z",
"belongs": 1,
"pivot": {
"id_orcamento": 33212219,
"id_tag": 273265,
"deal_id": 33212219,
"tag_id": 273265
}
}
]
}
}EXEMPLO DO JSON APÓS O AJUSTE
Após a implementação da mudança, o retorno não inclui mais as tags automaticamente, a menos que o parâmetro with=tags (e outros, como customFields) seja especificado:
{
"success": true,
"message": "OK",
"data": {
"id": 33212219,
"hash": "at91up5t9kw0oowswcsgs8408og4cc8",
"rdstation_reference": null,
"type_reference": null,
"reference": null,
"temperature": null,
"probability": null,
"account_id": 3873,
"pipeline_id": 82119,
"owner_id": 33059,
"stage_id": 515165,
"person_id": null,
"company_id": null,
"lost_reason_id": null,
"origin_id": null,
"started_in_stage_id": 515165,
"created_at": "2024-12-10 17:38:40",
"title": "cf feldens alterado json response",
"description": null,
"observation": null,
"status": 0,
"closed_at": null,
"reason_close": null,
"deleted": 0,
"freezed": 0,
"value": 0,
"order": 6,
"updated_at": "2025-01-09 14:44:39",
"last_stage_updated_at": "2025-01-09 14:44:39",
"value_mrr": 0,
"probably_closed_at": null,
"last_contact_at": null,
"stage_changed_at": null,
"frozen_at": null,
"lead_time": 30,
"customFields": [
{
"id": 548993,
"name": "Formula Teste",
"hash": "581c7c17c1e6b995656d42770fb35eea",
"type": 13,
"belongs": 1,
"value": "R$ 21,00",
"raw_value": 21,
"formula": "(Valor de MRR + 21)",
"output_type": "Financeiro",
"decimal_places": 2,
"allow_negative": 0,
"currency_id": 1,
"thousand_sep": 0,
"options": null,
"selected_options": null
},
{
"id": 549205,
"name": "dataNascimento",
"hash": "d563f58280b9a83e92699ac9ca0a191d",
"type": 1,
"belongs": 1,
"value": "opaaaa2222",
"raw_value": "opaaaa2222",
"formula": null,
"output_type": null,
"decimal_places": 0,
"allow_negative": null,
"currency_id": null,
"thousand_sep": null,
"options": null,
"selected_options": null
},
{
"id": 549207,
"name": "procedencia",
"hash": "1f451e00bb3ce5dd4364fc8c9d91fd70",
"type": 1,
"belongs": 1,
"value": "vamoooo",
"raw_value": "vamoooo",
"formula": null,
"output_type": null,
"decimal_places": 0,
"allow_negative": null,
"currency_id": null,
"thousand_sep": null,
"options": null,
"selected_options": null
},
{
"id": 551505,
"name": "teste fm",
"hash": "2ca7dda38e1a8654cf50b53c2433eada",
"type": 13,
"belongs": 1,
"value": "3,00",
"raw_value": 3,
"formula": "(2 + 1)",
"output_type": "Sem Formatação",
"decimal_places": 2,
"allow_negative": 0,
"currency_id": null,
"thousand_sep": 0,
"options": null,
"selected_options": null
}
],
"tags": [
{
"id": 273265,
"account_id": 3873,
"user_id": 33059,
"name": "[base] converteram | startup summit online 2023 | 24.07.23",
"color": "danger",
"created_at": "2023-07-24 14:53:57",
"belongs": 1,
"active": true
}
]
}
}Pronto! Agora você já sabe como ajustar o endpoint de oportunidades para suas integrações.
Em caso de dúvidas, chame nossa equipe no chat. 😉