{"openapi":"3.1.0","info":{"title":"CicloLog — API de Integrações Multitenant","version":"1.0.0","summary":"Contrato executável da operação logística, cadastros e webhooks.","description":"API interna de baixa exposição. O token é único por organização, armazenado como hash e rotacionável pelo painel."},"servers":[{"url":"https://masterlog.tech","description":"Ambiente atual"}],"tags":[{"name":"Conta e autenticação","description":"Identidade e capacidades do token interno."},{"name":"Visitas","description":"Criação, consulta, edição, itens, evidências e cancelamento lógico imediato."},{"name":"Planos","description":"Fachada v1 de planejamento: um plano de um dia corresponde a uma rota canônica."},{"name":"Rotas","description":"Roteiros, vínculos de visitas, veículo e motorista."},{"name":"Veículos","description":"Frota canônica, metas, apresentação e equipe padrão."},{"name":"Clientes","description":"Cadastro oficial de clientes e histórico operacional."},{"name":"Onboarding de clientes","description":"Entrada idempotente de novos clientes no quadro de onboarding."},{"name":"Assinaturas","description":"Planos recorrentes, vínculos com clientes e agenda futura de coletas."},{"name":"Usuários de campo","description":"Leitura segura de usuários de campo e vínculos com rotas; credenciais nunca são expostas."},{"name":"Produtos e recipientes","description":"Catálogo de produtos e recipientes utilizado no planejamento e nos checklists."},{"name":"Formulários e registros","description":"Definições publicadas, campos dinâmicos e registros operacionais concluídos."},{"name":"Checklists dos veículos","description":"Leitura dos checklists de materiais, dupla checagem, saída e chegada."},{"name":"Relatórios logísticos","description":"Indicadores consolidados da operação por período, sem expor dados de outros inquilinos."},{"name":"Chat operacional","description":"APIs internas de sessão para conversas, histórico, leitura, comunicados, alertas, SOS, reações, anexos e localização."},{"name":"Torre de Comando","description":"Chamados vinculados a visitas, histórico de movimentações, orientações e etapas de conclusão."},{"name":"Webhooks","description":"Assinaturas, entregas HMAC, retentativas e reprocessamento manual."}],"paths":{"/v1/accounts/me":{"get":{"operationId":"getIntegrationAccount","tags":["Conta e autenticação"],"summary":"Consultar conta da integração","description":"Confirma organização, token e capacidades liberadas.","security":[{"integrationToken":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"id":"token-id","email":"integracao@cicloorganico.com.br","organization":"integracao@cicloorganico.com.br","permissions":["visits","plans","routes","vehicles","customers","users:read","command_cases","webhooks"],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"token-id","email":"integracao@cicloorganico.com.br","organization":"integracao@cicloorganico.com.br","permissions":["visits","plans","routes","vehicles","customers","users:read","command_cases","webhooks"]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/routes/visits":{"get":{"operationId":"listVisits","tags":["Visitas"],"summary":"Listar visitas","description":"Lista visitas paginadas, inclusive canceladas, sem carregar binários de evidência.","security":[{"integrationToken":[]}],"parameters":[{"name":"planned_date","in":"query","required":false,"description":"Filtra pela data operacional.","schema":{"type":"string","format":"date","example":"2026-07-28"},"example":"2026-07-28"},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createVisits","tags":["Visitas"],"summary":"Criar uma ou várias visitas","description":"Cria até 500 visitas, preserva items e campos extras e aplica idempotência por identificador ou conteúdo.\n\nO corpo pode ser um objeto ou uma lista de até 500 objetos.\n\nUma visita cancelada não é reativada por repetir POST.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]}},"required":["title","address","planned_date"],"additionalProperties":false},"example":{"external_id":"make-visit-94821","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","planned_date":"2026-07-28","latitude":-22.9418,"longitude":-43.1912,"reference":"3345","window_start":"09:00","window_end":"12:00","items":[{"name":"Baldinho 19L","quantity":1}]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":201,"status_text":"Criada","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/routes/visits/{id}":{"get":{"operationId":"getVisit","tags":["Visitas"],"summary":"Consultar visita","description":"Aceita ID sequencial, external_id ou internal_id e inclui metadados de evidências.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de visita. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateVisit","tags":["Visitas"],"summary":"Editar visita","description":"Atualiza somente campos enviados e sincroniza a cópia canônica se a visita já estiver em rota.\n\nexternal_id é imutável.\n\nCampos omitidos permanecem inalterados.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de visita. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]}},"required":[],"additionalProperties":false},"example":{"window_start":"10:00","window_end":"13:00","notes":"Novo horário confirmado."}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"10:00","window_end":"13:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"10:00","window_end":"13:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"cancelVisit","tags":["Visitas"],"summary":"Cancelar visita imediatamente","description":"Muda o estado para canceled sem apagar a linha, mesmo em rota pronta ou em andamento.\n\nNão remove a visita do banco.\n\nAtualiza também visits na rota e dispara visit_canceled.\n\nRepetir o cancelamento é idempotente.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de visita. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","maxLength":1000,"example":"Cliente cancelou a coleta."}},"required":[],"additionalProperties":false},"example":{"reason":"Cliente cancelou a coleta."}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"canceled","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","cancellation_reason":"Cliente cancelou a coleta.","canceled_at":"2026-07-28T10:10:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"canceled","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","cancellation_reason":"Cliente cancelou a coleta.","canceled_at":"2026-07-28T10:10:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/api/integrations/visits/{id}/items":{"post":{"operationId":"appendVisitItems","tags":["Visitas"],"summary":"Adicionar itens à visita","description":"Acrescenta itens sem descarte silencioso e rejeita o total acima de 100.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de visita. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":100,"example":[{"name":"Baldinho","quantity":1}]}},"required":["items"],"additionalProperties":false},"example":{"items":[{"name":"Baldinho","quantity":1}]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","items_received":1,"success":true,"response_status":"success","status_code":201,"status_text":"Anexados","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":1554,"external_id":"make-visit-94821","internal_id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","title":"1BG | Maria Silva / Apt 402","address":"Rua Professor Luís Cantanhede, 249","latitude":-22.9418,"longitude":-43.1912,"planned_date":"2026-07-28","status":"pending","route":null,"reference":"3345","load":1,"load_2":19,"load_3":35,"window_start":"09:00","window_end":"12:00","contact_name":"Maria Silva","contact_phone":"5521999999999","notes":"Ligar antes de chegar.","tags":["troca"],"extra_field_values":{"id_visita_bubble":"94821"},"items":[{"name":"Baldinho 19L","quantity":1}],"pictures":[],"created":"2026-07-27T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","items_received":1},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"integer","readOnly":true,"example":1554},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"make-visit-94821"},{"type":"null"}]},"internal_id":{"type":"string","format":"uuid","readOnly":true,"example":"a3467c5e-237b-4b3d-baa8-8df2dc358b77"},"title":{"type":"string","maxLength":300,"example":"1BG | Maria Silva / Apt 402"},"address":{"type":"string","maxLength":1000,"example":"Rua Professor Luís Cantanhede, 249"},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90,"example":-22.9418},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180,"example":-43.1912},{"type":"null"}]},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["pending","staged","imported","completed","failed","canceled"],"readOnly":true,"example":"pending"},"route":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"load":{"anyOf":[{"type":"number","example":1},{"type":"null"}]},"load_2":{"anyOf":[{"type":"number","example":19},{"type":"null"}]},"load_3":{"anyOf":[{"type":"number","example":35},{"type":"null"}]},"priority_level":{"anyOf":[{"type":"integer","minimum":0,"example":2},{"type":"null"}]},"window_start":{"anyOf":[{"type":"string","format":"time","example":"09:00"},{"type":"null"}]},"window_end":{"anyOf":[{"type":"string","format":"time","example":"12:00"},{"type":"null"}]},"window_start_2":{"anyOf":[{"type":"string","format":"time","example":"14:00"},{"type":"null"}]},"window_end_2":{"anyOf":[{"type":"string","format":"time","example":"17:00"},{"type":"null"}]},"duration":{"anyOf":[{"type":"integer","minimum":0,"example":10},{"type":"null"}]},"contact_name":{"anyOf":[{"type":"string","maxLength":200,"example":"Maria Silva"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":80,"example":"5521999999999"},{"type":"null"}]},"contact_email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":5000,"example":"Ligar antes de chegar."},{"type":"null"}]},"visit_type":{"anyOf":[{"type":"string","maxLength":120,"example":"cliente_pf"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"},"example":["troca","preferência"]},"extra_field_values":{"type":"object","additionalProperties":true,"example":{"id_visita_bubble":"94821"}},"items":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[{"name":"Baldinho 19L","quantity":1}]},"pictures":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"cancellation_reason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"canceled_at":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"created":{"type":"string","format":"date-time","readOnly":true},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","title","address","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/plans":{"get":{"operationId":"listPlans","tags":["Planos"],"summary":"Listar planos","description":"Lista a fachada v1 paginada.","security":[{"integrationToken":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/plans/{id}":{"get":{"operationId":"getPlan","tags":["Planos"],"summary":"Consultar plano","description":"Recupera o plano e sua rota única.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updatePlan","tags":["Planos"],"summary":"Editar metadados do plano","description":"Atualiza nome e data; não substitui a coleção routes.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"}},"required":[],"additionalProperties":false},"example":{"name":"Plano atualizado 28/07"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano atualizado 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano atualizado 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archivePlan","tags":["Planos"],"summary":"Arquivar plano rascunho","description":"Arquiva logicamente apenas rascunhos.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"archived","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"archived","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/plans/create-plan":{"post":{"operationId":"createPlan","tags":["Planos"],"summary":"Criar plano de um dia","description":"Cria um rascunho com uma rota, IDs de visitas ou visitas completas.\n\nA v1 aceita exatamente uma rota e um único dia; entradas maiores são rejeitadas, nunca agregadas silenciosamente.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1}},"required":["name","start_date"],"additionalProperties":false},"example":{"name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","routes":[{"name":"Carro 05","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","visits":[1554]}]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false,"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Plano 28/07","start_date":"2026-07-28","end_date":"2026-07-28","status":"draft","routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"created":"2026-07-27T12:00:00.000Z","reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Plano 28/07"},"start_date":{"type":"string","format":"date","example":"2026-07-28"},"end_date":{"type":"string","format":"date","example":"2026-07-28"},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"maximum":1},"created":{"type":"string","readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","start_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/routes/routes":{"get":{"operationId":"listRoutes","tags":["Rotas"],"summary":"Listar rotas","description":"Lista rotas com visitas, veículo e motorista persistidos.","security":[{"integrationToken":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createRoute","tags":["Rotas"],"summary":"Criar rota rascunho","description":"Cria e atribui veículo, motorista e visitas.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]}},"required":["name","planned_date"],"additionalProperties":false},"example":{"name":"Rota Carro 05","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","visits":[1554]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":201,"status_text":"Criada","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/routes/routes/{id}":{"get":{"operationId":"getRoute","tags":["Rotas"],"summary":"Consultar rota","description":"Aceita UUID ou slug.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de rota. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateRoute","tags":["Rotas"],"summary":"Editar rota","description":"Atualiza metadados, veículo ou motorista; a lista de visitas é imutável pela v1.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de rota. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]}},"required":[],"additionalProperties":false},"example":{"name":"Rota Centro revisada","driver":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota Centro revisada","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota Centro revisada","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"draft","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archiveRoute","tags":["Rotas"],"summary":"Arquivar rota rascunho","description":"Preserva histórico e rejeita rotas prontas.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de rota. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"archived","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","plan":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","planned_date":"2026-07-28","vehicle":"Carro 05","driver":"Luiz Claudio de Souza Paim","visits":["1554"],"total_visits":1,"total_vehicles":1,"status":"archived","slug":"rota-2026-07-28-8f59cb5399","created":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"name":{"type":"string","example":"Rota de terça, dia 28/07"},"planned_date":{"type":"string","format":"date","example":"2026-07-28"},"vehicle":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Carro 05"},{"type":"null"}]},"driver":{"anyOf":[{"type":"object","additionalProperties":true,"example":"Luiz Claudio de Souza Paim"},{"type":"null"}]},"visits":{"type":"array","items":{"type":"integer"},"example":[1554]},"total_visits":{"type":"integer","readOnly":true},"total_vehicles":{"type":"integer","readOnly":true},"status":{"type":"string","enum":["draft","ready","archived"],"readOnly":true},"slug":{"type":"string","readOnly":true},"created":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name","planned_date"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/routes/vehicles":{"get":{"operationId":"listVehicles","tags":["Veículos"],"summary":"Listar veículos","description":"Lista frota, metas e equipe padrão.","security":[{"integrationToken":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createVehicle","tags":["Veículos"],"summary":"Criar veículo","description":"Persiste cadastro oficial, metas e apresentação.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"status":{"type":"string","enum":["available","inactive"],"example":"available"}},"required":["name"],"additionalProperties":false},"example":{"name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","color":"#f97316","status":"available"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z","success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/routes/vehicles/{id}":{"get":{"operationId":"getVehicle","tags":["Veículos"],"summary":"Consultar veículo","description":"Aceita UUID ou reference_id.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de veículo. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateVehicle","tags":["Veículos"],"summary":"Editar veículo","description":"PATCH preserva campos omitidos, inclusive metas e equipe padrão.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de veículo. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"status":{"type":"string","enum":["available","inactive"],"example":"available"}},"required":[],"additionalProperties":false},"example":{"capacity":120,"target_visits":80}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":120,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":120,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"available","modified":"2026-07-27T12:05:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archiveVehicle","tags":["Veículos"],"summary":"Desativar veículo","description":"Inativa sem apagar o histórico.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de veículo. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"inactive","modified":"2026-07-27T12:05:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f9219e5f-7a43-41e1-a244-b1b7a25efcb4","name":"Carro 05","capacity":100,"reference_id":"596923","license_plate":"ABC1D23","default_driver_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","default_helper_ids":[],"start_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","end_address":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110","start_location":{"latitude":-22.8589177,"longitude":-43.2521853},"end_location":{"latitude":-22.8589177,"longitude":-43.2521853},"target_visits":70,"color":"#f97316","emoji":"🚚","skills":[],"status":"inactive","modified":"2026-07-27T12:05:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"name":{"type":"string","example":"Carro 05"},"capacity":{"anyOf":[{"type":"number","minimum":0,"example":100},{"type":"null"}]},"reference_id":{"anyOf":[{"type":"string","example":"596923"},{"type":"null"}]},"license_plate":{"anyOf":[{"type":"string","example":"ABC1D23"},{"type":"null"}]},"default_driver_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"default_helper_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"start_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"end_address":{"type":"string","readOnly":true,"example":"Rua Dezenove de Outubro, 22 - Bonsucesso, Rio de Janeiro - RJ, CEP 21040-110"},"start_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"end_location":{"type":"object","additionalProperties":true,"readOnly":true,"example":{"latitude":-22.8589177,"longitude":-43.2521853}},"target_visits":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_addresses":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_1":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_2":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_load_3":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"target_distance_km":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}]},"color":{"type":"string","example":"#f97316"},"emoji":{"type":"string","example":"🚚"},"skills":{"type":"array","items":{"type":"string"},"readOnly":true,"example":[]},"status":{"type":"string","enum":["available","inactive"],"example":"available"},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/customers":{"get":{"operationId":"listCustomers","tags":["Clientes"],"summary":"Listar clientes","description":"Lista o cadastro oficial com busca e filtro de status.","security":[{"integrationToken":[]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Busca por nome, IDs, contato, endereço, bairro ou plano.","schema":{"type":"string","example":"Maria"},"example":"Maria"},{"name":"status","in":"query","required":false,"description":"Situação cadastral.","schema":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"]}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createCustomer","tags":["Clientes"],"summary":"Criar cliente","description":"Cria no cadastro oficial e devolve o objeto completo.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":["name"],"additionalProperties":false},"example":{"external_id":"bubble-customer-44","name":"Maria Silva","phone":"5521999999999","address":"Rua Professor Luís Cantanhede, 249","status":"Ativo","plan":"Semanal / 1 Baldinho"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/customers/{id}":{"get":{"operationId":"getCustomer","tags":["Clientes"],"summary":"Consultar cliente","description":"Consulta direta pelo UUID.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateCustomer","tags":["Clientes"],"summary":"Editar cliente","description":"PATCH real: campos omitidos permanecem inalterados.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]}},"required":[],"additionalProperties":false},"example":{"phone":"5521988887777","vip":true}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521988887777","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":true,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521988887777","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Ativo","active":true,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":true,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archiveCustomer","tags":["Clientes"],"summary":"Inativar cliente","description":"Muda status para Inativo e preserva o cadastro.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Inativo","active":false,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","external_id":"bubble-customer-44","reference":"3345","name":"Maria Silva","email":"maria@example.com","phone":"5521999999999","phone_2":null,"address":"Rua Professor Luís Cantanhede, 249","complement":"Apt 402","neighborhood":"Laranjeiras","latitude":-22.9418,"longitude":-43.1912,"status":"Inativo","active":false,"plan":"Semanal / 1 Baldinho","periodicity":"Semanal","collection_week":"A","collection_days":"terça","reward":null,"vip":false,"pause_start":null,"pause_end":null,"visit_count":42,"last_visit_at":"2026-07-21","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"external_id":{"anyOf":[{"type":"string","maxLength":160,"example":"bubble-customer-44"},{"type":"null"}]},"reference":{"anyOf":[{"type":"string","maxLength":160,"example":"3345"},{"type":"null"}]},"name":{"type":"string","maxLength":240,"example":"Maria Silva"},"email":{"anyOf":[{"type":"string","format":"email","maxLength":320,"example":"maria@example.com"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"phone_2":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"complement":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"latitude":{"anyOf":[{"type":"number","minimum":-90,"maximum":90},{"type":"null"}]},"longitude":{"anyOf":[{"type":"number","minimum":-180,"maximum":180},{"type":"null"}]},"status":{"type":"string","enum":["Ativo","Pausado","Inativo","Inadimplente"],"example":"Ativo"},"active":{"type":"boolean","readOnly":true,"example":true},"plan":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"periodicity":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_week":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"collection_days":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"reward":{"anyOf":[{"type":"string","maxLength":240},{"type":"null"}]},"vip":{"type":"boolean","default":false},"pause_start":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"pause_end":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"visit_count":{"type":"integer","readOnly":true},"last_visit_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"modified":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","name"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/customers/{id}/visits":{"get":{"operationId":"getCustomerVisits","tags":["Clientes"],"summary":"Consultar histórico de visitas","description":"Une visitas canônicas e recebidas pela API, sem duplicar a mesma execução.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"customerId":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","customerName":"Maria Silva","externalId":"bubble-customer-44","total":1,"items":[{"id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","taskId":"1554","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","title":"1BG | Maria Silva / Apt 402","status":"completed","source":"route"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"customerId":"b62c1d30-86ce-45f5-a845-9dc21b30be4e","customerName":"Maria Silva","externalId":"bubble-customer-44","total":1,"items":[{"id":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","taskId":"1554","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","title":"1BG | Maria Silva / Apt 402","status":"completed","source":"route"}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/bubble-master-sync":{"post":{"operationId":"syncBubbleMasterSubscription","tags":["Clientes"],"summary":"Sincronizar assinatura Bubble e Master","description":"Prepara, verifica e conclui a sincronização com Legacy ID físico e checkpoints por assinatura.\n\nExecutar prepare → releitura → verify → gravação RAW de writes → atualização/releitura Bubble → releitura Master → commit. Somente clientes novos recebem claim_email, confirmação email_sent e complete com onboarding.\n\nAnuais não provocam gravações. Nunca inserir/deslocar linhas. A ausência de Legacy ID não autoriza duplicar um cliente localizado por BX/BY.\n\nUm e-mail reclamado sem confirmação requer verificação manual no Make/Gmail; não é reenviado automaticamente.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","enum":["preview","prepare","verify","commit","claim_email","email_sent","complete"]},"payload":{"type":"object","additionalProperties":true},"user":{"type":"object","additionalProperties":true},"rows":{"type":"string"},"grid_rows":{"type":"integer"},"allowed_plans":{"type":"string"},"allowed_rewards":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"event_id":{"type":"string"},"row":{"type":"string"},"bubble_unique_id":{"type":"string"},"bubble_legacy_id":{"type":"integer"}},"required":["action"],"additionalProperties":false},"example":{"action":"preview","payload":{"assinatura":{"optou_plano_anual":"Pagamento Anual"}}}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"kind":"annual","stage":"ignored","writes":[],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"kind":"annual","stage":"ignored","writes":[]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"preview","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/customer-onboarding":{"post":{"operationId":"createCustomerOnboarding","tags":["Onboarding de clientes"],"summary":"Criar cartão de onboarding","description":"Cria de forma idempotente um cartão em Novos Clientes a partir de uma assinatura externa.\n\nRepetir external_provider + external_id reconcilia o mesmo cartão sem duplicação.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_id":{"type":"string","maxLength":180,"example":"bubble-subscription-94821"},"external_provider":{"type":"string","default":"bubble_subscription","maxLength":80},"pipeline_kind":{"type":"string","enum":["pf","pj"]},"customer_name":{"type":"string","maxLength":160,"example":"Maria Silva"},"customer_email":{"type":"string","maxLength":254,"example":"maria@example.com"},"company_name":{"anyOf":[{"type":"string","maxLength":180,"example":"Empresa Exemplo"},{"type":"null"}]},"contact_phone":{"anyOf":[{"type":"string","maxLength":40,"example":"5521999999999"},{"type":"null"}]},"address":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"neighborhood":{"anyOf":[{"type":"string","maxLength":120},{"type":"null"}]},"address_complement":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"plan":{"type":"string","maxLength":2000,"example":"Baldinho 19 L - semanal"},"collection_periodicity":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"total_contract_value":{"anyOf":[{"type":"string","example":"R$ 110,00"},{"type":"null"}]},"customer_information":{"type":"string","default":"-","maxLength":4000}},"required":["external_id","customer_name","customer_email","plan"],"additionalProperties":false},"example":{"external_id":"bubble-subscription-94821","pipeline_kind":"pj","customer_name":"Maria Silva","customer_email":"maria@example.com","company_name":"Empresa Exemplo","contact_phone":"5521999999999","address":"Rua Exemplo, 10","neighborhood":"Centro","plan":"Baldinho 19 L - semanal","collection_periodicity":"Semanal","total_contract_value":"R$ 110,00","customer_information":"Nova assinatura recebida do Bubble."}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"reused":false,"onboarding":{"id":"onboarding-id","stageId":"new_clients"},"opportunity":{"id":"opportunity-id","externalId":"bubble-subscription-94821"},"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"reused":false,"onboarding":{"id":"onboarding-id","stageId":"new_clients"},"opportunity":{"id":"opportunity-id","externalId":"bubble-subscription-94821"}},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"patch":{"operationId":"transitionCustomerOnboarding","tags":["Onboarding de clientes"],"summary":"Finalizar automação do onboarding","description":"Move de forma idempotente o cartão recebido por webhook para Onboarding Concluído ou Erro na automação.\n\nRetentativas devolvem reused=true quando o cartão já está no destino solicitado.\n\nVersões divergentes retornam 409 e preservam a movimentação feita por uma pessoa.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"onboarding_id":{"type":"string","format":"uuid"},"version":{"type":"integer","minimum":1},"destination_stage_id":{"type":"string","enum":["completed","automation_error"],"default":"completed"}},"required":["onboarding_id","version"],"additionalProperties":false},"example":{"onboarding_id":"onboarding-id","version":4,"destination_stage_id":"completed"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"reused":false,"onboarding":{"id":"onboarding-id","stageId":"completed","version":5},"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"reused":false,"onboarding":{"id":"onboarding-id","stageId":"completed","version":5}},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/subscriptions/plans":{"get":{"operationId":"listSubscriptionPlans","tags":["Assinaturas"],"summary":"Listar planos de assinatura","description":"Lista preços, periodicidade, produtos incluídos, promoções e legenda operacional.","security":[{"integrationToken":[]}],"parameters":[{"name":"include_inactive","in":"query","required":false,"description":"Inclui planos desativados.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","labels":[{"key":"coleta-semanal","label":"Coleta semanal","emoji":"♻️","color":"#16845b","titleLegend":"1BG","includeInTitle":true,"showOnMap":true,"filterable":true,"active":true}],"active":true}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","labels":[{"key":"coleta-semanal","label":"Coleta semanal","emoji":"♻️","color":"#16845b","titleLegend":"1BG","includeInTitle":true,"showOnMap":true,"filterable":true,"active":true}],"active":true}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createSubscriptionPlan","tags":["Assinaturas"],"summary":"Criar plano de assinatura","description":"Cria um plano no tenant e emite subscription_plan_created.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["code","name","cadence","priceCents"],"additionalProperties":false},"example":{"code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"items":[{"productCode":"baldinho-19l-reutilizado","quantity":1,"fulfillment":"service","includeInTitle":true}],"titleLegend":"1BG","labels":[{"key":"coleta-semanal","label":"Coleta semanal","emoji":"♻️","color":"#16845b","titleLegend":"1BG","includeInTitle":true,"showOnMap":true,"filterable":true,"active":true}],"active":true}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","labels":[{"key":"coleta-semanal","label":"Coleta semanal","emoji":"♻️","color":"#16845b","titleLegend":"1BG","includeInTitle":true,"showOnMap":true,"filterable":true,"active":true}],"active":true,"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","labels":[{"key":"coleta-semanal","label":"Coleta semanal","emoji":"♻️","color":"#16845b","titleLegend":"1BG","includeInTitle":true,"showOnMap":true,"filterable":true,"active":true}],"active":true},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/subscriptions/plans/{id}":{"get":{"operationId":"getSubscriptionPlan","tags":["Assinaturas"],"summary":"Consultar plano de assinatura","description":"Aceita o ID ou código do plano.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano de assinatura. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","active":true,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"titleLegend":"1BG","active":true},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateSubscriptionPlan","tags":["Assinaturas"],"summary":"Editar plano de assinatura","description":"Atualiza o plano e emite subscription_plan_updated.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano de assinatura. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":[],"additionalProperties":false},"example":{"promotionalPriceCents":9900,"promotionLabel":"Campanha de agosto"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"promotionalPriceCents":9900,"active":true,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"plan-id","code":"weekly-19l","name":"Coleta Semanal · Balde 19 L","cadence":"weekly","priceCents":11000,"promotionalPriceCents":9900,"active":true},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archiveSubscriptionPlan","tags":["Assinaturas"],"summary":"Desativar plano de assinatura","description":"Impede novas associações sem apagar assinaturas existentes.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de plano de assinatura. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"id":"plan-id","active":false,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"plan-id","active":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","example":"weekly-19l"},"name":{"type":"string","example":"Coleta Semanal · Balde 19 L"},"cadence":{"type":"string","enum":["none","weekly","biweekly","monthly"]},"intervalCount":{"type":"integer","default":1,"minimum":1},"priceCents":{"type":"integer","minimum":0,"example":11000},"promotionalPriceCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"promotionLabel":{"anyOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","additionalProperties":true}},"titleLegend":{"type":"string","example":"1BG"},"labels":{"type":"array","items":{"type":"object","additionalProperties":true}},"active":{"type":"boolean","default":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","name","cadence","priceCents"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/customers/{id}/subscriptions":{"get":{"operationId":"listCustomerSubscriptions","tags":["Assinaturas"],"summary":"Consultar assinatura e agenda futura","description":"Retorna vínculos do cliente e materializa coletas até a data through.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"},{"name":"through","in":"query","required":false,"description":"Horizonte inclusivo da agenda futura.","schema":{"type":"string","format":"date","example":"2026-11-30"},"example":"2026-11-30"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"customer_id":"customer-id","subscriptions":[{"id":"subscription-id","planId":"plan-id","status":"active","startDate":"2026-08-11","weekdays":[2]}],"future_visits":[{"scheduledDate":"2026-08-11","status":"scheduled"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"customer_id":"customer-id","subscriptions":[{"id":"subscription-id","planId":"plan-id","status":"active","startDate":"2026-08-11","weekdays":[2]}],"future_visits":[{"scheduledDate":"2026-08-11","status":"scheduled"}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createCustomerSubscription","tags":["Assinaturas"],"summary":"Associar assinatura ao cliente","description":"Vincula o plano e gera de forma idempotente as visitas futuras.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["planId","startDate","weekdays"],"additionalProperties":false},"example":{"planId":"plan-id","startDate":"2026-08-11","anchorDate":"2026-08-11","weekdays":[2]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"id":"subscription-id","customerId":"customer-id","planId":"plan-id","status":"active","startDate":"2026-08-11","weekdays":[2],"success":true,"response_status":"success","status_code":201,"status_text":"Criada","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"subscription-id","customerId":"customer-id","planId":"plan-id","status":"active","startDate":"2026-08-11","weekdays":[2]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/customers/{id}/subscriptions/{subscriptionId}":{"patch":{"operationId":"updateCustomerSubscription","tags":["Assinaturas"],"summary":"Pausar, reativar ou cancelar assinatura","description":"Atualiza status, dias, preço e observações e reconcilia a agenda ainda não roteada.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de cliente. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"},{"name":"subscriptionId","in":"path","required":true,"description":"Identificador da assinatura.","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":[],"additionalProperties":false},"example":{"status":"paused"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"id":"subscription-id","customerId":"customer-id","planId":"plan-id","status":"paused","startDate":"2026-08-11","weekdays":[2],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"subscription-id","customerId":"customer-id","planId":"plan-id","status":"paused","startDate":"2026-08-11","weekdays":[2]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"customerId":{"type":"string","readOnly":true},"planId":{"type":"string"},"status":{"type":"string","enum":["active","paused","cancelled"],"default":"active"},"startDate":{"type":"string","format":"date","example":"2026-08-11"},"endDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"anchorDate":{"type":"string","format":"date"},"weekdays":{"type":"array","items":{"type":"integer"},"example":[2]},"monthlyWeek":{"anyOf":[{"type":"string"},{"type":"null"}]},"priceOverrideCents":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","planId","startDate","weekdays"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/users":{"get":{"operationId":"listFieldUsers","tags":["Usuários de campo"],"summary":"Listar usuários de campo","description":"Leitura de perfis e vínculos; nenhuma credencial é retornada.\n\nCriação, senha, reset e sessões permanecem exclusivos da API administrativa autenticada.","security":[{"integrationToken":[]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Busca por nome, usuário, e-mail, telefone ou ID externo.","schema":{"type":"string","example":"Luiz"},"example":"Luiz"},{"name":"status","in":"query","required":false,"description":"Estado do acesso.","schema":{"type":"string","enum":["active","inactive"]}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","external_id":"motorista-05","display_name":"Luiz Claudio de Souza Paim","username":"luiz.paim","email":"luiz.paim@example.com","phone":"5521999999999","work_category":"driver","active":true,"last_login_at":"2026-07-28T10:00:00.000Z","profile_photo_url":null,"routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","slug":"rota-2026-07-28-8f59cb5399","route_date":"2026-07-28","role":"driver","vehicle_names":["Carro 05"]}],"created":"2026-01-10T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","external_id":"motorista-05","display_name":"Luiz Claudio de Souza Paim","username":"luiz.paim","email":"luiz.paim@example.com","phone":"5521999999999","work_category":"driver","active":true,"last_login_at":"2026-07-28T10:00:00.000Z","profile_photo_url":null,"routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","slug":"rota-2026-07-28-8f59cb5399","route_date":"2026-07-28","role":"driver","vehicle_names":["Carro 05"]}],"created":"2026-01-10T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/users/{id}":{"get":{"operationId":"getFieldUser","tags":["Usuários de campo"],"summary":"Consultar usuário de campo","description":"Consulta segura pelo UUID.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de usuário. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","external_id":"motorista-05","display_name":"Luiz Claudio de Souza Paim","username":"luiz.paim","email":"luiz.paim@example.com","phone":"5521999999999","work_category":"driver","active":true,"last_login_at":"2026-07-28T10:00:00.000Z","profile_photo_url":null,"routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","slug":"rota-2026-07-28-8f59cb5399","route_date":"2026-07-28","role":"driver","vehicle_names":["Carro 05"]}],"created":"2026-01-10T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","external_id":"motorista-05","display_name":"Luiz Claudio de Souza Paim","username":"luiz.paim","email":"luiz.paim@example.com","phone":"5521999999999","work_category":"driver","active":true,"last_login_at":"2026-07-28T10:00:00.000Z","profile_photo_url":null,"routes":[{"id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","name":"Rota de terça, dia 28/07","slug":"rota-2026-07-28-8f59cb5399","route_date":"2026-07-28","role":"driver","vehicle_names":["Carro 05"]}],"created":"2026-01-10T12:00:00.000Z","modified":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"external_id":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"display_name":{"type":"string","readOnly":true},"username":{"type":"string","readOnly":true},"email":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"work_category":{"type":"string","enum":["driver","helper","both","internal","internal_driver","internal_helper","aggregated","sporadic","compost_yard"],"readOnly":true},"active":{"type":"boolean","readOnly":true},"last_login_at":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"routes":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"profile_photo_url":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"created":{"type":"string","readOnly":true},"modified":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/chat/administrative-announcements":{"post":{"operationId":"publishAdministrativeAnnouncement","tags":["Chat operacional"],"summary":"Publicar aviso no chat Administrativo","description":"Publica um aviso idempotente do MasterLog Bot no canal corporativo Administrativo.\n\nA identidade do remetente é MasterLog Bot; nenhuma sessão administrativa é compartilhada com o Make.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"external_id":{"type":"string","maxLength":180,"example":"bubble-subscription-94821"},"title":{"type":"string","maxLength":200,"example":"Nova assinatura criada"},"detail":{"type":"string","maxLength":4000,"example":"Maria Silva assinou o plano semanal."},"occurrence_date":{"type":"string","format":"date","example":"2026-09-22"}},"required":["external_id","title","detail"],"additionalProperties":false},"example":{"external_id":"bubble-subscription-94821","title":"Nova assinatura criada","detail":"Maria Silva assinou o plano semanal.","occurrence_date":"2026-09-22"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"conversationId":"administrative-conversation-id","messageId":"message-id","reused":false,"success":true,"response_status":"success","status_code":201,"status_text":"Publicado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"conversationId":"administrative-conversation-id","messageId":"message-id","reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/conversations":{"get":{"operationId":"listAdminChatConversations","tags":["Chat operacional"],"summary":"Listar conversas do painel","description":"API interna por sessão administrativa e permissão chat:view.","security":[{"adminSession":[]}],"parameters":[{"name":"routeId","in":"query","required":false,"description":"Filtra por rota.","schema":{"type":"string","example":"378c261c-7bd7-4069-9c01-8ed3f219ca0d"},"example":"378c261c-7bd7-4069-9c01-8ed3f219ca0d"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"conversations":[{"id":"conversation-id","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","vehicleName":"Carro 05","unreadCount":2}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/api/chat/conversations/{id}/messages":{"get":{"operationId":"listAdminChatMessages","tags":["Chat operacional"],"summary":"Listar mensagens","description":"Leitura incremental por sessão e permissão chat:view.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"},{"name":"afterAt","in":"query","required":false,"description":"Retorna mensagens posteriores ao instante.","schema":{"type":"string","format":"date-time"}},{"name":"afterId","in":"query","required":false,"description":"Desempata mensagens no mesmo instante.","schema":{"type":"string"}},{"name":"historyDate","in":"query","required":false,"description":"Carrega o histórico do canal na data informada.","schema":{"type":"string","format":"date","example":"2026-07-28"},"example":"2026-07-28"},{"name":"history","in":"query","required":false,"description":"all carrega todo o histórico já persistido do canal no painel administrativo.","schema":{"type":"string","enum":["all"]}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"conversation":{"id":"conversation-id"},"messages":[{"id":"message-id","messageType":"text","body":"Chegando ao cliente.","receipts":[]}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"sendAdminChatMessage","tags":["Chat operacional"],"summary":"Enviar mensagem","description":"Envio multipart por sessão e permissão chat:write.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"messageId":{"type":"string","example":"5b539262-a856-4525-a842-20cd77102056"},"body":{"type":"string","maxLength":4000,"example":"Chegando ao cliente."},"attachment":{"type":"string"},"transcript":{"type":"string","maxLength":4000},"replyToMessageId":{"type":"string"},"mentions":{"type":"object","additionalProperties":true},"locationShare":{"type":"object","additionalProperties":true}},"required":[],"additionalProperties":false},"example":{"body":"Chegando ao cliente.","messageId":"5b539262-a856-4525-a842-20cd77102056"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"message":{"id":"5b539262-a856-4525-a842-20cd77102056","messageType":"text","body":"Chegando ao cliente."}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"patch":{"operationId":"markAdminChatConversationRead","tags":["Chat operacional"],"summary":"Marcar canal como lido","description":"Avança de forma durável a leitura de todas as conversas diárias do mesmo veículo.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"marked":true}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/conversations/{id}/messages/{messageId}/reactions":{"post":{"operationId":"reactToAdminChatMessage","tags":["Chat operacional"],"summary":"Reagir à mensagem","description":"Alterna uma reação permitida por participante.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"},{"name":"messageId","in":"path","required":true,"description":"Mensagem.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emoji":{"type":"string","enum":["👍","✅","❤️","😂","😊","🙏"],"example":"✅"}},"required":["emoji"],"additionalProperties":false},"example":{"emoji":"✅"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"reactions":[{"emoji":"✅","count":1}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/conversations/{id}/locations/{locationId}":{"patch":{"operationId":"updateAdminChatLocation","tags":["Chat operacional"],"summary":"Atualizar localização ao vivo","description":"Somente o autor atualiza ou encerra seu compartilhamento.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"},{"name":"locationId","in":"path","required":true,"description":"Compartilhamento.","schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"latitude":{"type":"number","minimum":-90,"maximum":90},"longitude":{"type":"number","minimum":-180,"maximum":180},"accuracy":{"anyOf":[{"type":"number","minimum":0,"maximum":100000},{"type":"null"}]},"stop":{"type":"boolean","default":false}},"required":[],"additionalProperties":false},"example":{"latitude":-22.94,"longitude":-43.19,"accuracy":12}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"location":{"id":"location-id","latitude":-22.94,"longitude":-43.19,"stopped_at":null}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/attachments/{id}":{"get":{"operationId":"downloadChatAttachment","tags":["Chat operacional"],"summary":"Baixar anexo","description":"Fluxo binário autenticado por sessão administrativa ou de campo.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de anexo. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"binary":true}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/broadcasts":{"get":{"operationId":"listAdminChatBroadcasts","tags":["Chat operacional"],"summary":"Listar comunicados","description":"Lista os últimos comunicados gerais e segmentados do painel.","security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"broadcasts":[{"id":"broadcast-id","body":"Atenção ao acesso do condomínio.","senderName":"Equipe de Logística","vehicleCount":4,"createdAt":"2026-07-28T14:00:00.000Z"}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"sendAdminChatBroadcast","tags":["Chat operacional"],"summary":"Enviar comunicado","description":"Distribui texto e anexo para veículos ou participantes selecionados.","security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":false,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"body":{"type":"string","maxLength":4000,"example":"Atenção ao acesso do condomínio."},"attachment":{"type":"string"},"targetConversationIds":{"type":"object","additionalProperties":true},"targetUserIds":{"type":"object","additionalProperties":true}},"required":[],"additionalProperties":false},"example":{"body":"Atenção ao acesso do condomínio.","targetConversationIds":"[\"conversation-id\"]"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"broadcast":{"id":"broadcast-id","body":"Atenção ao acesso do condomínio.","senderName":"Equipe de Logística","vehicleCount":1,"createdAt":"2026-07-28T14:00:00.000Z"}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/conversations/{id}/alerts":{"post":{"operationId":"createAdminChatAlert","tags":["Chat operacional"],"summary":"Enviar alerta operacional","description":"Cria uma solicitação confirmável para a equipe do veículo.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de conversa. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"targetUserIds":{"type":"array","items":{"type":"string"},"example":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"]}},"required":[],"additionalProperties":false},"example":{"targetUserIds":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"]}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"systemMessageId":"message-id","targets":[{"id":"alert-id","userId":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","name":"Luiz Claudio de Souza Paim","role":"driver"}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/chat/message-notifications":{"get":{"operationId":"listAdminChatNotifications","tags":["Chat operacional"],"summary":"Listar mensagens não lidas","description":"Lista mensagens, menções e SOS ainda não lidos pelo administrador.","security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"notifications":[{"id":"message-id","conversationId":"conversation-id","senderName":"Luiz","vehicleName":"Carro 05","preview":"Preciso de ajuda","mentioned":false,"persistent":true,"createdAt":"2026-07-28T14:00:00.000Z"}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"markAllAdminChatNotificationsRead","tags":["Chat operacional"],"summary":"Marcar todas como lidas","description":"Persiste recibos e avança o marcador de leitura de cada canal afetado.","security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"marked":14}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"dismissAdminChatNotification","tags":["Chat operacional"],"summary":"Dispensar notificação","description":"Marca uma mensagem específica como lida para o administrador.","security":[{"adminSession":[]}],"parameters":[{"name":"messageId","in":"query","required":true,"description":"Mensagem a dispensar.","schema":{"type":"string"}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"dismissed":true}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/operational/chat/alerts":{"get":{"operationId":"listFieldChatAlerts","tags":["Chat operacional"],"summary":"Listar alertas do coletor","description":"Lista alertas pendentes da identidade de campo, com filtro de rota e instante.","security":[{"fieldSession":[]}],"parameters":[{"name":"route","in":"query","required":false,"description":"Slug da rota.","schema":{"type":"string"}},{"name":"since","in":"query","required":false,"description":"Instante mínimo.","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"alerts":[{"id":"alert-id","conversationId":"conversation-id","vehicleName":"Carro 05","kind":"alert","detail":"A administração precisa falar com você."}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"field","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"acknowledgeFieldChatAlert","tags":["Chat operacional"],"summary":"Confirmar alerta","description":"Registra a confirmação individual do integrante da equipe.","security":[{"fieldSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"alertId":{"type":"string"}},"required":["alertId"],"additionalProperties":false},"example":{"alertId":"alert-id"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"acknowledged":true}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"field","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/operational/chat/sos":{"post":{"operationId":"createFieldChatSos","tags":["Chat operacional"],"summary":"Acionar SOS","description":"Registra um pedido persistente de ajuda a partir de uma visita da rota publicada.","security":[{"fieldSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"routeSlug":{"type":"string","example":"rota-2026-07-28-8f59cb5399"},"visitId":{"type":"string","example":"1554"}},"required":["routeSlug","visitId"],"additionalProperties":false},"example":{"routeSlug":"rota-2026-07-28-8f59cb5399","visitId":"1554"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"message":{"id":"message-id","messageType":"system","system":{"kind":"sos","title":"Pedido de ajuda no cliente"}}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"field","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/chatguru/command-events":{"post":{"operationId":"handleChatGuruCommandEvent","tags":["Torre de Comando"],"summary":"Receber evento do ChatGuru","description":"Relaciona o envio manual ou a resposta do cliente ao chamado e ao chat administrativo do veículo.\n\nUse contacted quando a mensagem manual foi enviada e customer_replied quando o cliente respondeu. O tenant vem exclusivamente do token. Referências conflitantes são rejeitadas antes de qualquer gravação.\n\nA etapa de espera é resolvida por systemBehavior=waiting, não pelo rótulo visível.\n\ncustomer_replied cria uma mensagem com audiência administrativa; coletores não recebem nem visualizam o conteúdo.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"event":{"type":"string","enum":["contacted","customer_replied"],"example":"contacted"},"event_id":{"type":"string","maxLength":500},"chat_id":{"type":"string","maxLength":200},"visit_id":{"type":"string","maxLength":200,"example":"1554"},"command_case_id":{"type":"string","format":"uuid"},"message":{"type":"string","maxLength":4000,"example":"Estou em casa, pode retornar."},"conversation_url":{"type":"string","format":"uri","example":"https://s8.chatguru.app/conversation/example"},"occurred_at":{"type":"string","format":"date-time"}},"required":["event"],"additionalProperties":false},"example":{"event":"contacted","chat_id":"chat-94821","visit_id":"1554","occurred_at":"2026-09-02T12:45:00-03:00"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":true,"data":{"success":true,"data":{"event":"contacted","command_case":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","phase":"waiting","contacted_at":"2026-09-02T15:45:00.000Z","response_deadline_at":"2026-09-02T15:50:00.000Z"}}},"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/command-cases/config":{"get":{"operationId":"getCommandWorkflow","tags":["Torre de Comando"],"summary":"Consultar configuração da Torre","description":"Retorna a revisão vigente, os campos dinâmicos e todas as etapas ordenadas com seus destinos permitidos.\n\nUse os IDs estáveis de phase, requiredFields, allowedTransitions e favoriteTransition. Nomes, cores, ordem e regras podem mudar entre revisões sem alterar a URL ou o formato da API.\n\nFaça cache por revision e recarregue ao receber command_workflow_updated.\n\nA edição da configuração é uma operação administrativa interna; o token de integração possui leitura somente.","security":[{"integrationToken":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"revision":3,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"revision":3,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"revision":{"type":"integer","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"phases":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","revision"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/command-cases":{"get":{"operationId":"listCommandCases","tags":["Torre de Comando"],"summary":"Listar chamados","description":"Lista chamados abertos por padrão e permite incluir casos concluídos e histórico.","security":[{"integrationToken":[]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Busca cliente, endereço, visita ou veículo.","schema":{"type":"string"}},{"name":"resolved","in":"query","required":false,"description":"Inclui etapas terminais.","schema":{"type":"boolean","default":false}},{"name":"conversation_id","in":"query","required":false,"description":"Filtra pela conversa do veículo.","schema":{"type":"string"}},{"name":"vehicle","in":"query","required":false,"description":"Filtra pelo nome exato do veículo.","schema":{"type":"string"}},{"name":"include_events","in":"query","required":false,"description":"Inclui o histórico de cada chamado.","schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"openCommandCase","tags":["Torre de Comando"],"summary":"Abrir chamado","description":"Abre ou reconcilia idempotentemente um chamado a partir de uma visita da organização.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"visit_id":{"type":"string","example":"1554"}},"required":["visit_id"],"additionalProperties":false},"example":{"visit_id":"1554"}}}},"responses":{"200":{"description":"A visita já possuía um chamado; retorna o mesmo registro com reused=true.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"new","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[],"reused":false,"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"new","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[],"reused":false},"error":null}}}}}},"201":{"description":"Novo chamado aberto e vinculado à visita.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"new","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[],"reused":false,"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"new","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[],"reused":false},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/command-cases/{id}":{"get":{"operationId":"getCommandCase","tags":["Torre de Comando"],"summary":"Consultar chamado","description":"Retorna o chamado e todo o histórico de abertura e movimentações.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de chamado. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"transitionCommandCase","tags":["Torre de Comando"],"summary":"Movimentar chamado","description":"Move o chamado e executa os efeitos da etapa, como orientar a rota ou criar recoleta.\n\nOs campos obrigatórios e destinos são dinâmicos. Consulte a configuração ou availableTransitions antes de movimentar.\n\nCampos legados continuam aceitos, mas field_values é o contrato canônico para novas integrações.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de chamado. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phase":{"type":"string","example":"waiting"},"field_values":{"type":"object","additionalProperties":true,"example":{"instructions":"Retornar após as 16h."}},"instructions":{"type":"string","maxLength":1000},"recollectionDate":{"type":"string","format":"date"},"extraBucket":{"type":"string","maxLength":200},"nextCollectionDate":{"type":"string","format":"date"}},"required":["phase"],"additionalProperties":false},"example":{"phase":"waiting"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","format":"uuid","readOnly":true},"routeId":{"type":"string","format":"uuid","readOnly":true},"routeName":{"type":"string","readOnly":true},"routeDate":{"anyOf":[{"type":"string","format":"date","readOnly":true},{"type":"null"}]},"visitId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"visitTaskId":{"type":"string","readOnly":true},"conversationId":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"customerName":{"type":"string","readOnly":true},"customerReference":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phone":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"email":{"anyOf":[{"type":"string","format":"email","readOnly":true},{"type":"null"}]},"address":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"vehicleName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"collectorName":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureReason":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"evidenceUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"phase":{"type":"string","example":"waiting"},"outcome":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"priority":{"type":"string","enum":["low","normal","high","urgent"],"readOnly":true},"instructions":{"anyOf":[{"type":"string","maxLength":1000},{"type":"null"}]},"contactedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"responseDeadlineAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"nextCollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"recollectionDate":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"extraBucket":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"fieldValues":{"type":"object","additionalProperties":true,"readOnly":true},"workflowRevision":{"type":"integer","readOnly":true},"phaseDefinition":{"type":"object","additionalProperties":true,"readOnly":true},"availableTransitions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"resolvedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"dueAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","readOnly":true},"updatedAt":{"type":"string","format":"date-time","readOnly":true},"events":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"reused":{"type":"boolean","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","phase"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/command-cases":{"get":{"operationId":"listAdminCommandCases","tags":["Torre de Comando"],"summary":"Listar chamados no painel","description":"API interna usada pelo Kanban e pelas threads fixadas no chat.","security":[{"adminSession":[]}],"parameters":[{"name":"q","in":"query","required":false,"description":"Busca textual.","schema":{"type":"string"}},{"name":"resolved","in":"query","required":false,"description":"1 inclui concluídos.","schema":{"type":"string","enum":["1"]}},{"name":"conversation","in":"query","required":false,"description":"Conversa.","schema":{"type":"string"}},{"name":"vehicle","in":"query","required":false,"description":"Veículo.","schema":{"type":"string"}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"cases":[{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}],"workflow":{"revision":3,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"openAdminCommandCase","tags":["Torre de Comando"],"summary":"Abrir chamado no painel","description":"Abre o chamado com a identidade e auditoria do administrador.","security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"visitId":{"type":"string","example":"1554"}},"required":["visitId"],"additionalProperties":false},"example":{"visitId":"1554"}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"case":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"new","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/command-cases/{id}":{"get":{"operationId":"getAdminCommandCase","tags":["Torre de Comando"],"summary":"Consultar chamado no painel","description":"Retorna o chamado completo usado pela layer do chat e pelo Kanban.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de chamado. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"case":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]},"workflow":{"revision":3,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"transitionAdminCommandCase","tags":["Torre de Comando"],"summary":"Movimentar chamado no painel","description":"Aplica a transição com a identidade do administrador e registra auditoria.","security":[{"adminSession":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de chamado. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"phase":{"type":"string"},"field_values":{"type":"object","additionalProperties":true},"instructions":{"type":"string"},"recollectionDate":{"type":"string","format":"date"},"extraBucket":{"type":"string"},"nextCollectionDate":{"type":"string","format":"date"}},"required":["phase"],"additionalProperties":false},"example":{"phase":"waiting"}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"case":{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/command-cases/config":{"get":{"operationId":"getAdminCommandWorkflow","tags":["Torre de Comando"],"summary":"Consultar configuração no painel","description":"Carrega a central de configuração com permissão command:view.","security":[{"adminSession":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"workflow":{"revision":3,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"put":{"operationId":"updateAdminCommandWorkflow","tags":["Torre de Comando"],"summary":"Atualizar configuração no painel","description":"Salva atomicamente as etapas, ordem, cores, campos obrigatórios e destinos com controle otimista de revisão.\n\nExige command:manage e gera auditoria command_workflow.updated.\n\nEtapas já publicadas não podem ser excluídas porque seus IDs podem existir no histórico; renomeie ou reorganize.","security":[{"adminSession":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"revision":{"type":"integer"},"phases":{"type":"array","items":{"type":"object","additionalProperties":true}}},"required":["revision","phases"],"additionalProperties":false},"example":{"revision":3,"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"workflow":{"revision":4,"updatedAt":"2026-08-03T12:00:00.000Z","fields":[{"id":"instructions","apiName":"instructions","legacyApiName":"instructions","label":"Instruções para o coletor","description":"Orientação registrada na thread.","type":"textarea","maxLength":1000},{"id":"recollectionDate","apiName":"recollection_date","legacyApiName":"recollectionDate","label":"Data da nova coleta / recoleta","description":"Data da nova visita.","type":"date"}],"phases":[{"id":"new","label":"🙋‍♂️ Novos chamados","color":"#6f58d9","position":0,"terminal":false,"initial":true,"requiredFields":[],"allowedTransitions":["waiting"],"favoriteTransition":"waiting","active":true},{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","position":1,"terminal":false,"initial":false,"requiredFields":[],"allowedTransitions":["immediate_return"],"favoriteTransition":"immediate_return","active":true}]}}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"admin","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/api/operational/command-cases":{"get":{"operationId":"listFieldCommandCases","tags":["Torre de Comando"],"summary":"Listar threads do coletor","description":"Retorna somente chamados abertos do veículo autorizado na conversa.","security":[{"fieldSession":[]}],"parameters":[{"name":"conversation","in":"query","required":true,"description":"Conversa autorizada.","schema":{"type":"string"}}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"cases":[{"id":"244763cb-4a70-4554-8daf-ef4b67b30d01","routeId":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","routeName":"Rota de terça, dia 28/07","routeDate":"2026-07-28","visitId":"a3467c5e-237b-4b3d-baa8-8df2dc358b77","visitTaskId":"1554","conversationId":"4ef7e560-9737-43d2-8200-b718853b76f5","customerName":"Maria Silva","customerReference":"3345","phone":"5521999999999","email":"maria@example.com","address":"Rua Professor Luís Cantanhede, 249","vehicleName":"Carro 05","collectorName":"Luiz Claudio de Souza Paim","failureReason":"📵 Sem contato.","evidenceUrl":null,"phase":"waiting","outcome":null,"priority":"high","instructions":"Aguardar cinco minutos e tentar novamente.","contactedAt":"2026-07-28T14:05:00.000Z","responseDeadlineAt":"2026-07-28T14:10:00.000Z","nextCollectionDate":null,"recollectionDate":null,"extraBucket":null,"fieldValues":{},"workflowRevision":3,"phaseDefinition":{"id":"waiting","label":"⏳ Aguardando a resposta","color":"#d79a12","terminal":false,"requiredFields":[],"favoriteTransition":"immediate_return"},"availableTransitions":[{"id":"immediate_return","label":"🔙 Retorno imediato","color":"#2f9a59","terminal":false,"requiredFields":["instructions"]}],"resolvedAt":null,"dueAt":"2026-07-28T20:30:00.000Z","createdAt":"2026-07-28T14:00:00.000Z","updatedAt":"2026-07-28T14:05:00.000Z","events":[{"id":"72c1443f-5400-42d2-9c80-e11470c8f847","eventType":"transition","fromPhase":"new","toPhase":"waiting","actorName":"Equipe de Logística","detail":{},"createdAt":"2026-07-28T14:05:00.000Z"}]}]}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato."}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Token ou sessão ausente, inválido, expirado ou revogado."}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"A identidade é válida, mas não possui a permissão exigida."}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O recurso não existe dentro da organização autenticada."}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Estado atual, identificador idempotente ou vínculo impede a operação."}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"O corpo ou anexo ultrapassa o limite documentado."}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{},"required":[],"additionalProperties":false},"examples":{"default":{"value":{"error":"Falha inesperada rastreável por request_id e x-request-id."}}}}}}},"x-ciclo-audience":"field","x-ciclo-stability":"internal","x-ciclo-api-version":"internal-2026-07","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/products":{"get":{"operationId":"listProducts","tags":["Produtos e recipientes"],"summary":"Listar produtos","description":"Lista o catálogo ativo, incluindo padrões e sobrescritas.","security":[{"integrationToken":[]}],"parameters":[{"name":"include_inactive","in":"query","required":false,"description":"Inclui itens desativados.","schema":{"type":"boolean","default":false}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createProduct","tags":["Produtos e recipientes"],"summary":"Criar produto","description":"Cria um item no catálogo da empresa e emite product_created.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}}},"required":["code","title"],"additionalProperties":false},"example":{"code":"caixa-retorno","title":"Caixa de retorno","aliases":["caixa retornável"],"active":true,"metadata":{"categoryKey":"materiais-operacionais"}}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"id":"e13689b7-57e0-4d1e-a352-70ec6b2dd6bf","code":"caixa-retorno","title":"Caixa de retorno","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":false,"updatedAt":null,"success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"e13689b7-57e0-4d1e-a352-70ec6b2dd6bf","code":"caixa-retorno","title":"Caixa de retorno","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":false,"updatedAt":null},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/products/{id}":{"get":{"operationId":"getProduct","tags":["Produtos e recipientes"],"summary":"Consultar produto","description":"Aceita UUID, code ou identificador default:<code>.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de produto. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateProduct","tags":["Produtos e recipientes"],"summary":"Editar produto","description":"Atualiza somente os campos enviados e emite product_updated.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de produto. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}}},"required":[],"additionalProperties":false},"example":{"aliases":["caixa retorno","caixa retornável"],"sortOrder":12}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":true,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"archiveProduct","tags":["Produtos e recipientes"],"summary":"Desativar produto","description":"Desativa sem apagar o histórico e emite product_deleted.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de produto. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":false,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"default:baldinho-19l-reutilizado","code":"baldinho-19l-reutilizado","title":"Baldinho de 19 L — reutilizado","description":null,"aliases":["balde 19 litros"],"imageUrl":null,"active":false,"sortOrder":3,"metadata":{"categoryKey":"baldes-sacolas","reservePerVehicle":3},"isDefault":true,"updatedAt":null},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"code":{"type":"string","maxLength":160,"example":"baldinho-19l-reutilizado"},"title":{"type":"string","maxLength":240,"example":"Baldinho de 19 L — reutilizado"},"description":{"anyOf":[{"type":"string"},{"type":"null"}]},"aliases":{"type":"array","items":{"type":"string"},"example":["balde 19 litros"]},"imageUrl":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"active":{"type":"boolean","default":true},"sortOrder":{"type":"integer","default":0,"minimum":0},"metadata":{"type":"object","additionalProperties":true,"example":{"categoryKey":"baldes-sacolas","reservePerVehicle":3}},"isDefault":{"type":"boolean","readOnly":true},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","code","title"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/forms":{"get":{"operationId":"listPublishedForms","tags":["Formulários e registros"],"summary":"Listar formulários publicados","description":"Lista versões publicadas e seus campos, sem rascunhos.","security":[{"integrationToken":[]}],"parameters":[],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"form:tenant:dds","formKey":"dds","name":"Registro da DDS","description":"Presença, horário e assuntos da conversa diária de segurança.","triggerType":"dds","status":"published","version":2,"rankingEnabled":true,"completionPoints":0,"settings":{"confirmationMessage":"Registro concluído."},"fields":[{"key":"attendanceStatus","label":"Status de presença","type":"matrix","required":true,"options":["Presente","Ausente"],"scoreOptions":{"Presente":1}}],"publishedAt":"2026-08-06T12:00:00.000Z","updatedAt":"2026-08-06T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"form:tenant:dds","formKey":"dds","name":"Registro da DDS","description":"Presença, horário e assuntos da conversa diária de segurança.","triggerType":"dds","status":"published","version":2,"rankingEnabled":true,"completionPoints":0,"settings":{"confirmationMessage":"Registro concluído."},"fields":[{"key":"attendanceStatus","label":"Status de presença","type":"matrix","required":true,"options":["Presente","Ausente"],"scoreOptions":{"Presente":1}}],"publishedAt":"2026-08-06T12:00:00.000Z","updatedAt":"2026-08-06T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/forms/{formKey}":{"get":{"operationId":"getPublishedForm","tags":["Formulários e registros"],"summary":"Consultar formulário publicado","description":"Retorna configuração completa por chave estável.","security":[{"integrationToken":[]}],"parameters":[{"name":"formKey","in":"path","required":true,"description":"Chave publicada.","schema":{"type":"string","example":"dds"},"example":"dds"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"id":"form:tenant:dds","formKey":"dds","name":"Registro da DDS","description":"Presença, horário e assuntos da conversa diária de segurança.","triggerType":"dds","status":"published","version":2,"rankingEnabled":true,"completionPoints":0,"settings":{"confirmationMessage":"Registro concluído."},"fields":[{"key":"attendanceStatus","label":"Status de presença","type":"matrix","required":true,"options":["Presente","Ausente"],"scoreOptions":{"Presente":1}}],"publishedAt":"2026-08-06T12:00:00.000Z","updatedAt":"2026-08-06T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"form:tenant:dds","formKey":"dds","name":"Registro da DDS","description":"Presença, horário e assuntos da conversa diária de segurança.","triggerType":"dds","status":"published","version":2,"rankingEnabled":true,"completionPoints":0,"settings":{"confirmationMessage":"Registro concluído."},"fields":[{"key":"attendanceStatus","label":"Status de presença","type":"matrix","required":true,"options":["Presente","Ausente"],"scoreOptions":{"Presente":1}}],"publishedAt":"2026-08-06T12:00:00.000Z","updatedAt":"2026-08-06T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"formKey":{"type":"string","readOnly":true,"example":"dds"},"name":{"type":"string","readOnly":true},"description":{"type":"string","readOnly":true},"triggerType":{"type":"string","readOnly":true},"status":{"type":"string","enum":["published"],"readOnly":true},"version":{"type":"integer","readOnly":true},"rankingEnabled":{"type":"boolean","readOnly":true},"completionPoints":{"type":"number","readOnly":true},"settings":{"type":"object","additionalProperties":true,"readOnly":true},"fields":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"publishedAt":{"anyOf":[{"type":"string","format":"date-time","readOnly":true},{"type":"null"}]},"updatedAt":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","formKey"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/forms/submissions":{"get":{"operationId":"listFormSubmissions","tags":["Formulários e registros"],"summary":"Listar registros","description":"Lista registros operacionais por formulário e mês, com paginação.","security":[{"integrationToken":[]}],"parameters":[{"name":"form_key","in":"query","required":false,"description":"Filtra a chave do formulário.","schema":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]}},{"name":"month","in":"query","required":false,"description":"Mês YYYY-MM.","schema":{"type":"string","example":"2026-08"},"example":"2026-08"},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createFormSubmission","tags":["Formulários e registros"],"summary":"Criar registro","description":"Valida formulário, vínculos e pontuação; emite form_submission_created.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}}},"required":["form_key","occurrence_date","payload"],"additionalProperties":false},"example":{"form_key":"card","occurrence_date":"2026-08-06","subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."}}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z","success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}},"/v1/forms/submissions/{id}":{"get":{"operationId":"getFormSubmission","tags":["Formulários e registros"],"summary":"Consultar registro","description":"Retorna respostas, vínculos, responsáveis e efeito de pontuação.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de registro. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"patch":{"operationId":"updateFormSubmission","tags":["Formulários e registros"],"summary":"Editar registro","description":"Revalida respostas, recalcula pontuação e emite form_submission_updated.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de registro. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}}},"required":[],"additionalProperties":false},"example":{"payload":{"cardType":"Amarelo","details":"Revisão do registro."}}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Amarelo","details":"Revisão do registro."},"score_effect":-2,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Amarelo","details":"Revisão do registro."},"score_effect":-2,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"deleteFormSubmission","tags":["Formulários e registros"],"summary":"Excluir registro","description":"Exclui com cascata e emite form_submission_deleted.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de registro. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z","deleted":true,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"f183b75c-243c-4a7e-b35a-58c174ce3d38","form_key":"card","occurrence_date":"2026-08-06","route_id":null,"fleet_vehicle_id":null,"visit_id":null,"subject_user_id":"69df16d7-0ce8-46c4-88c3-9028c5cb80ba","participant_user_ids":["69df16d7-0ce8-46c4-88c3-9028c5cb80ba"],"payload":{"cardType":"Verde","details":"Atuação exemplar."},"score_effect":1,"created_at":"2026-08-06T12:00:00.000Z","updated_at":"2026-08-06T12:00:00.000Z","deleted":true},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"form_key":{"type":"string","enum":["card","dds","absence","collection_feedback","refuel","route_review"]},"occurrence_date":{"type":"string","format":"date","example":"2026-08-06"},"route_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"fleet_vehicle_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"visit_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject_user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"participant_user_ids":{"type":"array","items":{"type":"object","additionalProperties":true},"example":[]},"payload":{"type":"object","additionalProperties":true,"example":{"cardType":"Verde","details":"Atuação exemplar."}},"score_effect":{"type":"number","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","form_key","occurrence_date","payload"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/fleet/checklists":{"get":{"operationId":"listVehicleChecklists","tags":["Checklists dos veículos"],"summary":"Listar checklists dos veículos","description":"Lista materiais, dupla checagem, saída e chegada, sem binários.","security":[{"integrationToken":[]}],"parameters":[{"name":"route_id","in":"query","required":false,"description":"Filtra a rota.","schema":{"type":"string"}},{"name":"vehicle","in":"query","required":false,"description":"Filtra o nome exato do veículo.","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Filtra a etapa.","schema":{"type":"string","enum":["materials","materials_double_check","departure","arrival"]}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"e2442e86-e49f-4f76-9d42-6966e83d4997","route_id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","route_name":"Rota de terça, dia 28/07","route_date":"2026-07-28","vehicle_name":"Carro 05","checklist_type":"departure","submitted_by_name":"Luiz Claudio de Souza Paim","answers":{"odometer":48210,"fuelLevel":"1/2 tanque"},"completed_at":"2026-07-28T09:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"e2442e86-e49f-4f76-9d42-6966e83d4997","route_id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","route_name":"Rota de terça, dia 28/07","route_date":"2026-07-28","vehicle_name":"Carro 05","checklist_type":"departure","submitted_by_name":"Luiz Claudio de Souza Paim","answers":{"odometer":48210,"fuelLevel":"1/2 tanque"},"completed_at":"2026-07-28T09:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/fleet/checklists/{id}":{"get":{"operationId":"getVehicleChecklist","tags":["Checklists dos veículos"],"summary":"Consultar checklist do veículo","description":"Retorna uma submissão validada dentro da empresa autenticada.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de checklist. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"id":"e2442e86-e49f-4f76-9d42-6966e83d4997","route_id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","route_name":"Rota de terça, dia 28/07","route_date":"2026-07-28","vehicle_name":"Carro 05","checklist_type":"departure","submitted_by_name":"Luiz Claudio de Souza Paim","answers":{"odometer":48210,"fuelLevel":"1/2 tanque"},"completed_at":"2026-07-28T09:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"e2442e86-e49f-4f76-9d42-6966e83d4997","route_id":"378c261c-7bd7-4069-9c01-8ed3f219ca0d","route_name":"Rota de terça, dia 28/07","route_date":"2026-07-28","vehicle_name":"Carro 05","checklist_type":"departure","submitted_by_name":"Luiz Claudio de Souza Paim","answers":{"odometer":48210,"fuelLevel":"1/2 tanque"},"completed_at":"2026-07-28T09:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"route_id":{"type":"string","readOnly":true},"route_name":{"type":"string","readOnly":true},"route_date":{"type":"string","format":"date","readOnly":true},"vehicle_name":{"type":"string","readOnly":true},"checklist_type":{"type":"string","enum":["materials","materials_double_check","departure","arrival"],"readOnly":true},"submitted_by_name":{"type":"string","readOnly":true},"answers":{"type":"object","additionalProperties":true,"readOnly":true},"completed_at":{"type":"string","format":"date-time","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/reports/logistics":{"get":{"operationId":"getLogisticsReport","tags":["Relatórios logísticos"],"summary":"Consultar indicadores logísticos","description":"Consolida produtividade, sucesso, utilização, evolução e exceções no período.","security":[{"integrationToken":[]}],"parameters":[{"name":"from","in":"query","required":false,"description":"Data inicial inclusiva.","schema":{"type":"string","format":"date","example":"2026-07-01"},"example":"2026-07-01"},{"name":"to","in":"query","required":false,"description":"Data final inclusiva.","schema":{"type":"string","format":"date","example":"2026-07-31"},"example":"2026-07-31"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"period":{"from":"2026-07-01","to":"2026-07-31","routes":24},"metrics":{"total":1750,"completed":1682,"failed":68,"completedWithoutFailure":1640,"completionRate":96,"completedWithoutFailureRate":98,"productivity":72.1,"utilization":91},"trend":[{"date":"2026-07-28","route":"Rota de terça, dia 28/07","total":74,"completed":71,"failed":3,"progress":96}],"exceptions":[{"type":"Falha","severity":"critical","route":"Rota de terça, dia 28/07","detail":"Cliente ausente"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"period":{"from":"2026-07-01","to":"2026-07-31","routes":24},"metrics":{"total":1750,"completed":1682,"failed":68,"completedWithoutFailure":1640,"completionRate":96,"completedWithoutFailureRate":98,"productivity":72.1,"utilization":91},"trend":[{"date":"2026-07-28","route":"Rota de terça, dia 28/07","total":74,"completed":71,"failed":3,"progress":96}],"exceptions":[{"type":"Falha","severity":"critical","route":"Rota de terça, dia 28/07","detail":"Cliente ausente"}]},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"period":{"type":"object","additionalProperties":true,"readOnly":true},"metrics":{"type":"object","additionalProperties":true,"readOnly":true},"trend":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true},"exceptions":{"type":"array","items":{"type":"object","additionalProperties":true},"readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/addons/webhooks":{"get":{"operationId":"listWebhooks","tags":["Webhooks"],"summary":"Listar webhooks","description":"Lista configurações sem revelar o signing_secret.","security":[{"integrationToken":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":true,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":true,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false},"post":{"operationId":"createWebhook","tags":["Webhooks"],"summary":"Criar webhook","description":"Cria destino HTTPS e segredo HMAC.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"active":{"type":"boolean","default":true}},"required":["events","url"],"additionalProperties":false},"example":{"events":["visit_created","visit_updated","visit_canceled"],"url":"https://hook.make.com/ciclo","headers":{},"active":true}}}},"responses":{"201":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":true,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z","signing_secret":"copie-este-segredo-retornado-somente-agora","success":true,"response_status":"success","status_code":201,"status_text":"Criado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":true,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z","signing_secret":"copie-este-segredo-retornado-somente-agora"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"put":{"operationId":"updateWebhook","tags":["Webhooks"],"summary":"Editar webhook","description":"Atualiza por id; omitir signing_secret preserva o segredo atual.","security":[{"integrationToken":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"active":{"type":"boolean","default":true}},"required":["id","events","url"],"additionalProperties":false},"example":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","active":false}}}},"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":false,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z","success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":false,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false},"delete":{"operationId":"deleteWebhook","tags":["Webhooks"],"summary":"Excluir webhook","description":"Remove configuração e suas entregas por cascata.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"query","required":true,"description":"Webhook a excluir.","schema":{"type":"string","example":"4d792b81-ec3d-44d2-b625-2d61b699b577"},"example":"4d792b81-ec3d-44d2-b625-2d61b699b577"}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":false,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z","deleted":true,"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"4d792b81-ec3d-44d2-b625-2d61b699b577","events":["visit_created","visit_updated","visit_canceled"],"webhook":"visit_created","url":"https://hook.make.com/ciclo","headers":{},"hasSigningSecret":true,"active":false,"lastDeliveryAt":null,"failureCount":0,"createdAt":"2026-07-27T12:00:00.000Z","updatedAt":"2026-07-27T12:00:00.000Z","deleted":true},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"id":{"type":"string","readOnly":true},"events":{"type":"array","items":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]},"example":["visit_created","visit_updated","visit_canceled"]},"webhook":{"type":"string","readOnly":true,"example":"visit_created"},"url":{"type":"string","format":"uri","example":"https://hook.make.com/ciclo"},"headers":{"type":"object","additionalProperties":true,"example":{"x-api-key":"segredo-do-destino"}},"signing_secret":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}]},"hasSigningSecret":{"type":"boolean","readOnly":true},"active":{"type":"boolean","default":true},"lastDeliveryAt":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"failureCount":{"type":"integer","readOnly":true},"createdAt":{"type":"string","readOnly":true},"updatedAt":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error","id","events","url"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":true}},"/v1/addons/webhooks/deliveries":{"get":{"operationId":"listWebhookDeliveries","tags":["Webhooks"],"summary":"Listar entregas","description":"Histórico paginado com tentativas, HTTP e último erro.\n\nx-ciclo-signature = sha256=HMAC_SHA256(signing_secret, x-ciclo-timestamp + '.' + corpo_bruto).","security":[{"integrationToken":[]}],"parameters":[{"name":"status","in":"query","required":false,"description":"Filtra o estado.","schema":{"type":"string","enum":["pending","processing","retrying","delivered","failed","dead_letter"]}},{"name":"event","in":"query","required":false,"description":"Filtra o evento.","schema":{"type":"string","enum":["integration_token_created","integration_token_rotated","integration_token_revoked","visit_created","visit_updated","visit_deleted","visit_canceled","visit_on_its_way","visit_checkout","visit_checkout_detailed","visit_failed","plan_created","plan_edited","plan_deleted","route_created","route_edited","route_deleted","route_started","route_finished","vehicle_created","vehicle_updated","vehicle_deleted","customer_created","customer_updated","customer_deleted","customer_onboarding_moved","subscription_plan_created","subscription_plan_updated","subscription_plan_archived","customer_subscription_created","customer_subscription_updated","product_created","product_updated","product_deleted","form_submission_created","form_submission_updated","form_submission_deleted","vehicle_checklist_submitted","vehicle_checklist_updated","vehicle_checklist_deleted","user_created","user_updated","user_deleted","chat_message_created","chat_attachment_created","chat_reaction_updated","chat_location_updated","chat_conversation_read","chat_broadcast_created","chat_alert_created","chat_alert_acknowledged","chat_sos_created","command_case_opened","command_case_transitioned","command_workflow_updated","command_case_resolved","webhook_created","webhook_updated","webhook_deleted"]}},{"name":"cursor","in":"query","required":false,"description":"Cursor opaco devolvido em next_cursor. Não altere nem construa este valor.","schema":{"type":"string","example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},"example":"eyJ2IjoxLCJvZmZzZXQiOjUwfQ"},{"name":"limit","in":"query","required":false,"description":"Quantidade de itens por página.","schema":{"type":"integer","default":50,"minimum":1,"maximum":100,"example":50},"example":50}],"responses":{"200":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"count":1,"next":null,"previous":null,"next_cursor":null,"limit":50,"results":[{"id":"delivery-id","webhookId":"4d792b81-ec3d-44d2-b625-2d61b699b577","event":"visit_canceled","status":"delivered","responseStatus":200,"attempts":1,"lastError":null,"createdAt":"2026-07-28T10:10:00.000Z","deliveredAt":"2026-07-28T10:10:01.000Z"}],"success":true,"response_status":"success","status_code":200,"status_text":"Sucesso","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":[{"id":"delivery-id","webhookId":"4d792b81-ec3d-44d2-b625-2d61b699b577","event":"visit_canceled","status":"delivered","responseStatus":200,"attempts":1,"lastError":null,"createdAt":"2026-07-28T10:10:00.000Z","deliveredAt":"2026-07-28T10:10:01.000Z"}],"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]},"count":{"type":"integer","readOnly":true,"example":128},"next":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"previous":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"next_cursor":{"anyOf":[{"type":"string","readOnly":true},{"type":"null"}]},"limit":{"type":"integer","readOnly":true,"example":50},"results":{"type":"string","readOnly":true}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":true,"x-ciclo-destructive":false}},"/v1/addons/webhooks/deliveries/{id}/replay":{"post":{"operationId":"replayWebhookDelivery","tags":["Webhooks"],"summary":"Reprocessar entrega","description":"Reenfileira falhas, dead letters ou retentativas sem criar novo evento.","security":[{"integrationToken":[]}],"parameters":[{"name":"id","in":"path","required":true,"description":"Identificador de entrega. O endpoint informa quando UUID, slug, ID externo ou sequencial são aceitos.","schema":{"type":"string","example":"1554"},"example":"1554"}],"responses":{"202":{"description":"Retorna o estado completo efetivamente persistido.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"id":"delivery-id","status":"pending","replayedAt":"2026-07-28T11:00:00.000Z","success":true,"response_status":"success","status_code":202,"status_text":"Aceita","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":{"id":"delivery-id","status":"pending","replayedAt":"2026-07-28T11:00:00.000Z"},"error":null}}}}}},"400":{"description":"JSON, parâmetro, formato, tamanho ou enum incompatível com o contrato.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":400,"status_text":"Requisição inválida","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"401":{"description":"Token ou sessão ausente, inválido, expirado ou revogado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":401,"status_text":"Não autorizado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"403":{"description":"A identidade é válida, mas não possui a permissão exigida.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":403,"status_text":"Acesso negado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"404":{"description":"O recurso não existe dentro da organização autenticada.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":404,"status_text":"Não encontrado","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"409":{"description":"Estado atual, identificador idempotente ou vínculo impede a operação.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":409,"status_text":"Conflito","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"413":{"description":"O corpo ou anexo ultrapassa o limite documentado.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":413,"status_text":"Conteúdo grande","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}},"500":{"description":"Falha inesperada rastreável por request_id e x-request-id.","headers":{"x-request-id":{"description":"Identificador rastreável da requisição.","schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","readOnly":true,"example":true},"response_status":{"type":"string","enum":["success","error"],"readOnly":true,"example":"success"},"status_code":{"type":"integer","readOnly":true,"example":200},"status_text":{"type":"string","readOnly":true,"example":"Operação concluída."},"request_id":{"type":"string","format":"uuid","readOnly":true,"example":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a"},"data":{"type":"object","additionalProperties":true,"readOnly":true},"error":{"anyOf":[{"type":"object","additionalProperties":true,"readOnly":true},{"type":"null"}]}},"required":["success","response_status","status_code","status_text","request_id","data","error"],"additionalProperties":false},"examples":{"default":{"value":{"success":false,"response_status":"error","status_code":500,"status_text":"Erro interno","request_id":"6c2fcaf6-d691-4df9-98dd-547fdd5a4b2a","data":null,"error":{"code":"example_error","message":"Descrição do erro.","details":null}}}}}}}},"x-ciclo-audience":"integration","x-ciclo-stability":"stable","x-ciclo-api-version":"v1","x-ciclo-safe-to-try":false,"x-ciclo-destructive":false}}},"components":{"securitySchemes":{"integrationToken":{"type":"apiKey","in":"header","name":"Authorization","description":"Authorization: Token <token>"},"adminSession":{"type":"apiKey","in":"cookie","name":"sessão administrativa","description":"Cookie HttpOnly gerenciado pelo painel."},"fieldSession":{"type":"apiKey","in":"cookie","name":"sessão de campo","description":"Cookie HttpOnly do aplicativo de campo."}}}}