Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.
{
"success": false,
"message": "Erro interno do servidor"
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Ephra","colors":{"primary":"#A264EF","light":"#BC8FF4","dark":"#8533EA"},"logo":{"light":"https://mintcdn.com/ephraio-2770e271/P99IW4fu260p_4Rw/logo/ephra-logo-dark.svg?fit=max\u0026auto=format\u0026n=P99IW4fu260p_4Rw\u0026q=85\u0026s=021a7b3727e2605213721e43451d67da","dark":"https://mintcdn.com/ephraio-2770e271/P99IW4fu260p_4Rw/logo/ephra-logo-light.svg?fit=max\u0026auto=format\u0026n=P99IW4fu260p_4Rw\u0026q=85\u0026s=bdcd4d3db0b242114b7e59470a3c3957","href":"https://docs.ephra.io"},"favicon":"https://mintcdn.com/ephraio-2770e271/P99IW4fu260p_4Rw/logo/favicon.svg?fit=max\u0026auto=format\u0026n=P99IW4fu260p_4Rw\u0026q=85\u0026s=65ddb21ad25607646e556b42f8df42b0","api":{"mdx":{"auth":{"method":"bearer"},"server":"https://api.ephra.io"}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"/novidades","label":"Novidades"},{"href":"mailto:suporte@ephra.io","label":"Suporte"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.ephra.io"}},"footer":{"socials":{"github":"https://github.com/Ephra-Tecnologia"}},"fonts":{"family":"Inter"},"styling":{"codeblocks":"system","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity",{"title":"Conectar MCP de ações","description":"Autentique sua empresa para consultar e alterar dados na Ephra.","icon":"robot","href":"https://docs.ephra.io/guias/mcp"},"mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ephraio-2770e271","hasAudioNarration":false,"actualSubdomain":"ephraio-2770e271","customDomains":["docs.ephra.io"],"gitSource":{"type":"github","owner":"ephra-tecnologia","repo":"external-docs","deployBranch":"main","isPrivate":true,"contentDirectory":"","mountPath":"","label":""},"chroma":{"collectionId":"33742480-8369-4a9f-8d4a-6b2e80d9c5b0","liveDeploymentHistoryId":"6ae1064907d47401a61944a1","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1064907d47401a61944a1"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae1064907d47401a61944a1","clientVersion":"0.0.4071","searchFilterCounts":[{"language":"default","tag":"Referência da API","count":213},{"language":"default","tag":"Área de membros","count":39},{"language":"default","tag":"Documentação","count":35},{"language":"default","tag":"Webhooks","count":22},{"language":"default","tag":"Módulos e aulas","count":17},{"language":"default","tag":"Reembolsos","count":14},{"language":"default","tag":"Guias","count":13},{"language":"default","tag":"Cupons","count":12},{"language":"default","tag":"Integrações","count":12},{"language":"default","tag":"Produtos","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/vendas/atualizar-um-cliente","slug":"/api-reference/vendas/atualizar-um-cliente","pageMetadata":{"title":"Atualizar um cliente","description":"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/customers/{customerId}","href":"/api-reference/vendas/atualizar-um-cliente","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"system","config":{},"pageMetadata":{"title":"Atualizar um cliente","description":"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/customers/{customerId}","href":"/api-reference/vendas/atualizar-um-cliente","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateCustomer","summary":"Atualizar um cliente","tags":["Vendas"],"description":"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.","requestBody":"7ac8f24c-61d5-47ac-b97e-1f8076dd2823","parameters":["e15a8249-da8c-4215-8adf-bb6332aaa2cc"],"security":["9a1b7c22-547b-4b4f-9735-0171cb252796"],"responses":{"200":"538dcc64-c6c4-473d-a142-91c291fd0512","400":"63acfe46-725a-40eb-8485-576d31773503","401":"3a9ed7be-7657-4884-9904-cc132e92cb5a","404":"38bb3c18-c8a2-4d79-9451-178e8ba4a6cc","422":"ca01bc73-17e1-4ce8-8b0f-5a6a32d3bedc","429":"3f63e6c8-9d63-4ed9-a952-92766f8517ff","500":"64925ddb-b0f5-4fcf-b486-29baa0cdeef0"},"method":"put","type":"path","servers":["3b7cebb4-f6a4-4fdf-97a4-9b779e820af9"],"path":"/v1/customers/{customerId}","baseUrlOptions":["https://api.ephra.io"],"title":"Atualizar um cliente","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e15a8249-da8c-4215-8adf-bb6332aaa2cc":{"schema":{"type":"string","minLength":1,"isRequired":true,"description":"Identificador do cliente.","uniqueKey":"","typeLabel":"string"},"in":"path","name":"customerId","required":true,"description":"Identificador do cliente."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160,"description":"Nome completo do cliente.","uniqueKey":"name","typeLabel":"string"},"email":{"type":"string","format":"email","description":"E-mail principal do cliente.","uniqueKey":"email","typeLabel":"string\u003cemail>"},"phone":{"type":"string","minLength":8,"description":"Telefone do cliente, com DDI e DDD.","uniqueKey":"phone","typeLabel":"string"},"birthDate":{"type":"string","format":"date-time","description":"Data de nascimento (ISO 8601).","uniqueKey":"birthDate","typeLabel":"string\u003cdate-time>"},"mailMarketing":{"type":"boolean","description":"Marque `true` quando o cliente aceitou receber marketing.","uniqueKey":"mailMarketing","typeLabel":"boolean"},"taxFree":{"type":"boolean","description":"Marque `true` quando o cliente é isento de imposto.","uniqueKey":"taxFree","typeLabel":"boolean"},"tags":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"maxItems":20,"description":"Etiquetas livres para segmentar o cliente.","uniqueKey":"tags","typeLabel":"string[]"},"notes":{"type":"string","maxLength":1000,"description":"Anotações internas sobre o cliente.","uniqueKey":"notes","typeLabel":"string"},"address":{"type":"object","properties":{"street":{"type":"string","minLength":1,"description":"Logradouro.","isRequired":true,"uniqueKey":"address.street","typeLabel":"string"},"streetNumber":{"type":"string","minLength":1,"description":"Número.","isRequired":true,"uniqueKey":"address.streetNumber","typeLabel":"string"},"neighborhood":{"type":"string","minLength":1,"description":"Bairro.","isRequired":true,"uniqueKey":"address.neighborhood","typeLabel":"string"},"city":{"type":"string","minLength":1,"description":"Município.","isRequired":true,"uniqueKey":"address.city","typeLabel":"string"},"state":{"type":"string","minLength":2,"maxLength":2,"description":"Sigla da unidade federativa.","isRequired":true,"uniqueKey":"address.state","typeLabel":"string"},"zipCode":{"type":"string","minLength":8,"description":"CEP, com ou sem máscara.","isRequired":true,"uniqueKey":"address.zipCode","typeLabel":"string"},"complement":{"type":"string","description":"Complemento, quando houver.","uniqueKey":"address.complement","typeLabel":"string"}},"required":["street","streetNumber","neighborhood","city","state","zipCode"],"additionalProperties":false,"description":"Endereço de entrega do cliente.","uniqueKey":"address","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"email":"mariana.alves@empresadela.com.br","phone":"+5521997766554","tags":["lancamento-setembro","cliente-recorrente","nota-cnpj"]},"examples":{"Example":{"title":"Example","value":{"email":"mariana.alves@empresadela.com.br","phone":"+5521997766554","tags":["lancamento-setembro","cliente-recorrente","nota-cnpj"]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"538dcc64-c6c4-473d-a142-91c291fd0512":{"description":"Cliente atualizado.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `true` em uma resposta bem-sucedida.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"data":{"type":"object","properties":{"id":{"type":"string","description":"Identificador do cliente.","isRequired":true,"uniqueKey":"data.id","typeLabel":"string"},"name":{"type":"string","description":"Nome completo do cliente.","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"email":{"oneOf":[{"type":"string","description":"E-mail principal do cliente.","isRequired":true,"uniqueKey":"data.email.oneOf.0","typeLabel":"string"},{"type":"null","description":"E-mail principal do cliente.","isRequired":true,"uniqueKey":"data.email.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","description":"Telefone do cliente, com DDI e DDD.","isRequired":true,"uniqueKey":"data.phone.oneOf.0","typeLabel":"string"},{"type":"null","description":"Telefone do cliente, com DDI e DDD.","isRequired":true,"uniqueKey":"data.phone.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.phone","typeLabel":"string | null"},"document":{"type":"string","description":"CPF ou CNPJ, apenas dígitos.","isRequired":true,"uniqueKey":"data.document","typeLabel":"string"},"documentType":{"type":"string","description":"Tipo do documento, deduzido do número: `CPF` ou `CNPJ`.","isRequired":true,"uniqueKey":"data.documentType","typeLabel":"string"},"instagram":{"oneOf":[{"type":"string","description":"Perfil do Instagram informado no checkout.","isRequired":true,"uniqueKey":"data.instagram.oneOf.0","typeLabel":"string"},{"type":"null","description":"Perfil do Instagram informado no checkout.","isRequired":true,"uniqueKey":"data.instagram.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.instagram","typeLabel":"string | null"},"birthDate":{"oneOf":[{"type":"string","format":"date-time","description":"Data de nascimento.","isRequired":true,"uniqueKey":"data.birthDate.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Data de nascimento.","isRequired":true,"uniqueKey":"data.birthDate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.birthDate","typeLabel":"string\u003cdate-time> | null"},"mailMarketing":{"type":"boolean","description":"`true` quando o cliente aceitou receber comunicação de marketing.","isRequired":true,"uniqueKey":"data.mailMarketing","typeLabel":"boolean"},"taxFree":{"type":"boolean","description":"`true` quando o cliente é isento de imposto na emissão de nota.","isRequired":true,"uniqueKey":"data.taxFree","typeLabel":"boolean"},"tags":{"type":"array","items":{"type":"string","uniqueKey":"data.tags.items.[INDEX]","typeLabel":"string"},"description":"Etiquetas livres usadas para segmentar o cliente.","isRequired":true,"uniqueKey":"data.tags","typeLabel":"string[]"},"notes":{"oneOf":[{"type":"string","description":"Anotações internas do vendedor sobre o cliente.","isRequired":true,"uniqueKey":"data.notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Anotações internas do vendedor sobre o cliente.","isRequired":true,"uniqueKey":"data.notes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.notes","typeLabel":"string | null"},"address":{"oneOf":[{"type":"object","properties":{"street":{"type":"string","description":"Logradouro.","isRequired":true,"uniqueKey":"data.address.oneOf.0.street","typeLabel":"string"},"streetNumber":{"type":"string","description":"Número.","isRequired":true,"uniqueKey":"data.address.oneOf.0.streetNumber","typeLabel":"string"},"complement":{"oneOf":[{"type":"string","description":"Complemento, quando houver.","isRequired":true,"uniqueKey":"data.address.oneOf.0.complement.oneOf.0","typeLabel":"string"},{"type":"null","description":"Complemento, quando houver.","isRequired":true,"uniqueKey":"data.address.oneOf.0.complement.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.address.oneOf.0.complement","typeLabel":"string | null"},"neighborhood":{"type":"string","description":"Bairro.","isRequired":true,"uniqueKey":"data.address.oneOf.0.neighborhood","typeLabel":"string"},"city":{"type":"string","description":"Município.","isRequired":true,"uniqueKey":"data.address.oneOf.0.city","typeLabel":"string"},"state":{"type":"string","description":"Sigla da unidade federativa, com duas letras.","isRequired":true,"uniqueKey":"data.address.oneOf.0.state","typeLabel":"string"},"zipCode":{"type":"string","description":"CEP, apenas dígitos.","isRequired":true,"uniqueKey":"data.address.oneOf.0.zipCode","typeLabel":"string"}},"required":["street","streetNumber","complement","neighborhood","city","state","zipCode"],"additionalProperties":false,"description":"Endereço de entrega do cliente.","isRequired":true,"uniqueKey":"data.address.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"street":{"type":"string","description":"Logradouro."},"streetNumber":{"type":"string","description":"Número."},"complement":{"oneOf":[{"type":"string","description":"Complemento, quando houver."},{"type":"null","description":"Complemento, quando houver."}]},"neighborhood":{"type":"string","description":"Bairro."},"city":{"type":"string","description":"Município."},"state":{"type":"string","description":"Sigla da unidade federativa, com duas letras."},"zipCode":{"type":"string","description":"CEP, apenas dígitos."}},"required":["street","streetNumber","complement","neighborhood","city","state","zipCode"],"additionalProperties":false,"description":"Endereço de entrega do cliente.","isRequired":true,"uniqueKey":"data.address.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.address","typeLabel":"object | null"},"createdAt":{"type":"string","format":"date-time","description":"Momento de criação do cadastro.","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Momento da última alteração.","isRequired":true,"uniqueKey":"data.updatedAt","typeLabel":"string\u003cdate-time>"}},"required":["id","name","email","phone","document","documentType","instagram","birthDate","mailMarketing","taxFree","tags","notes","address","createdAt","updatedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["success","data"],"additionalProperties":false,"description":"Cliente atualizado.","uniqueKey":"","typeLabel":"object"},"example":{"success":true,"data":{"id":"cmtxc7d910004hlg1q8w2ker3","name":"Mariana Ribeiro Alves","email":"mariana.alves@empresadela.com.br","phone":"+5521998877665","document":"39053344705","documentType":"CPF","instagram":"@mariana.alves","birthDate":"1991-04-17T00:00:00.000Z","mailMarketing":true,"taxFree":false,"tags":["lancamento-setembro","cliente-recorrente"],"notes":"Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.","address":{"street":"Rua Visconde de Pirajá","streetNumber":"414","complement":"sala 1108","neighborhood":"Ipanema","city":"Rio de Janeiro","state":"RJ","zipCode":"22410002"},"createdAt":"2026-08-14T11:20:33.000Z","updatedAt":"2026-09-09T16:41:02.000Z"}},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":"cmtxc7d910004hlg1q8w2ker3","name":"Mariana Ribeiro Alves","email":"mariana.alves@empresadela.com.br","phone":"+5521998877665","document":"39053344705","documentType":"CPF","instagram":"@mariana.alves","birthDate":"1991-04-17T00:00:00.000Z","mailMarketing":true,"taxFree":false,"tags":["lancamento-setembro","cliente-recorrente"],"notes":"Pediu nota fiscal com o CNPJ da empresa dela a partir da próxima compra.","address":{"street":"Rua Visconde de Pirajá","streetNumber":"414","complement":"sala 1108","neighborhood":"Ipanema","city":"Rio de Janeiro","state":"RJ","zipCode":"22410002"},"createdAt":"2026-08-14T11:20:33.000Z","updatedAt":"2026-09-09T16:41:02.000Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"63acfe46-725a-40eb-8485-576d31773503":{"description":"A requisição está bem formada, mas uma regra de negócio a recusou.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"A requisição está bem formada, mas uma regra de negócio a recusou.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Não foi possível concluir: uma regra de negócio recusou os dados enviados."},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Não foi possível concluir: uma regra de negócio recusou os dados enviados."}}},"exampleType":"examples"}},"exampleType":"examples"},"3a9ed7be-7657-4884-9904-cc132e92cb5a":{"description":"Token ausente, inválido, expirado ou de empresa bloqueada.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"Token ausente, inválido, expirado ou de empresa bloqueada.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Token inválido ou expirado"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Token inválido ou expirado"}}},"exampleType":"examples"}},"exampleType":"examples"},"38bb3c18-c8a2-4d79-9451-178e8ba4a6cc":{"description":"O recurso não existe, foi excluído ou pertence a outra empresa.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"O recurso não existe, foi excluído ou pertence a outra empresa.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Recurso não encontrado"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Recurso não encontrado"}}},"exampleType":"examples"}},"exampleType":"examples"},"ca01bc73-17e1-4ce8-8b0f-5a6a32d3bedc":{"description":"A requisição não passou na validação de schema.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"A requisição não passou na validação de schema.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"name: Nome é obrigatório"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"name: Nome é obrigatório"}}},"exampleType":"examples"}},"exampleType":"examples"},"3f63e6c8-9d63-4ed9-a952-92766f8517ff":{"description":"Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Muitas requisições. Tente novamente em breve."},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Muitas requisições. Tente novamente em breve."}}},"exampleType":"examples"}},"headers":{"retry-after":{"description":"Segundos a esperar antes de repetir a requisição.","schema":{"type":"integer"}},"x-ratelimit-limit":{"description":"Teto de requisições na janela (1000). Presente em toda resposta.","schema":{"type":"integer"}},"x-ratelimit-remaining":{"description":"Quantas requisições ainda cabem na janela atual. Presente em toda resposta.","schema":{"type":"integer"}},"x-ratelimit-reset":{"description":"Segundos até o contador da janela zerar. Presente em toda resposta.","schema":{"type":"integer"}}},"exampleType":"examples"},"64925ddb-b0f5-4fcf-b486-29baa0cdeef0":{"description":"Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Sempre `false` em uma resposta de erro.","isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"message":{"type":"string","description":"Mensagem legível explicando a falha.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"additionalProperties":false,"description":"Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota.","uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Erro interno do servidor"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Erro interno do servidor"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9a1b7c22-547b-4b4f-9735-0171cb252796":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"3b7cebb4-f6a4-4fdf-97a4-9b779e820af9":{"url":"https://api.ephra.io","description":"Servidor de produção"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"ephraio-2770e271","siteName":"Ephra","title":"Atualizar um cliente - Ephra","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-20T12:00:25.842Z","originalFileLocation":"api-reference/vendas/atualizar-um-cliente.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ephra\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Atualizar um cliente - Ephra\">\u003cmeta data-mint-head property=\"og:description\" content=\"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ephra\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ephraio-2770e271.mintlify.app/_mintlify/api/og/v2?division=Clientes\u0026amp;title=Atualizar+um+cliente\u0026amp;description=Corrige+os+dados+cadastrais+informados+de+um+cliente+da+empresa+autenticada+%E2%80%94+e-mail%2C+telefone%2C+endere%C3%A7o+de+entrega%2C+etiquetas+%E2%80%94+mantendo+o+hist%C3%B3rico+de+compras\u0026amp;theme=00b95a490e33c1f9c035ecc8\u0026amp;signature=e6ab3a09cdce9d84946259f946ea8c0e9d2cba1338e4975a74ae1c0802a3c3a8\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Atualizar um cliente - Ephra\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ephraio-2770e271.mintlify.app/_mintlify/api/og/v2?division=Clientes\u0026amp;title=Atualizar+um+cliente\u0026amp;description=Corrige+os+dados+cadastrais+informados+de+um+cliente+da+empresa+autenticada+%E2%80%94+e-mail%2C+telefone%2C+endere%C3%A7o+de+entrega%2C+etiquetas+%E2%80%94+mantendo+o+hist%C3%B3rico+de+compras\u0026amp;theme=00b95a490e33c1f9c035ecc8\u0026amp;signature=e6ab3a09cdce9d84946259f946ea8c0e9d2cba1338e4975a74ae1c0802a3c3a8\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ephraio-2770e271/VbGl3YpHnFeJi5v3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ephra\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#A264EF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/vendas/atualizar-um-cliente.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ephra.io/#organization\",\"name\":\"Ephra\",\"url\":\"https://docs.ephra.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ephraio-2770e271/P99IW4fu260p_4Rw/logo/ephra-logo-dark.svg?fit=max\u0026auto=format\u0026n=P99IW4fu260p_4Rw\u0026q=85\u0026s=021a7b3727e2605213721e43451d67da\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ephra.io#website\",\"name\":\"Ephra\",\"url\":\"https://docs.ephra.io\",\"publisher\":{\"@id\":\"https://docs.ephra.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente#webpage\",\"url\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente\",\"name\":\"Atualizar um cliente\",\"description\":\"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\",\"dateModified\":\"2026-10-20T12:00:25.842Z\",\"isPartOf\":{\"@id\":\"https://docs.ephra.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Clientes\",\"item\":\"https://docs.ephra.io/api-reference/vendas/listar-clientes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Atualizar um cliente\",\"item\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente#apireference\",\"headline\":\"Atualizar um cliente\",\"name\":\"Atualizar um cliente\",\"description\":\"Corrige os dados cadastrais informados de um cliente da empresa autenticada — e-mail, telefone, endereço de entrega, etiquetas — mantendo o histórico de compras. Os campos omitidos ficam como estão. O documento não é alterável. Responde 404 quando o cliente pertence a outra empresa.\",\"url\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ephra.io/api-reference/vendas/atualizar-um-cliente#webpage\"},\"dateModified\":\"2026-10-20T12:00:25.842Z\",\"publisher\":{\"@id\":\"https://docs.ephra.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ephra.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ephra\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ephra","nav":{"global":null,"tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":""}]},{"tab":"Referência da API","groups":[{"group":"Começo","pages":[{"title":"Introdução","icon":"book-open","href":"/api-reference/introducao"},{"title":"Obter token de acesso","openapi":"openapi-transacional.yaml POST /auth","href":"/api-reference/autenticacao"},{"title":"Status e erros","icon":"list","href":"/api-reference/status-e-erros"}]},{"group":"Pagamentos","pages":[{"title":"Criar cobrança PIX (QR Code)","openapi":"openapi-transacional.yaml POST /v1/pix/in/qrcode","href":"/api-reference/pix-qrcode"},{"title":"Criar cobrança PIX (com vencimento)","openapi":"openapi-transacional.yaml POST /v1/pix/in/cob","href":"/api-reference/pix-cobranca"},{"title":"Tokenizar cartão","openapi":"openapi-transacional.yaml POST /v1/card-token","href":"/api-reference/cartao-token"},{"title":"Criar cobrança no cartão","openapi":"openapi-transacional.yaml POST /v1/card","href":"/api-reference/cartao-cobranca"},{"title":"Criar cobrança via boleto","openapi":"openapi-transacional.yaml POST /v1/boleto","tag":"Descontinuado","href":"/api-reference/boleto"}]},{"group":"Vendas","pages":[{"title":"Listar transações","openapi":"openapi-transacional.yaml GET /v1/transactions","href":"/api-reference/transacoes-listar"},{"title":"Consultar transação","openapi":"openapi-transacional.yaml GET /v1/transactions/{transactionId}","href":"/api-reference/transacoes-consultar"},{"title":"Exportar vendas em CSV","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/transactions/export","href":"/api-reference/vendas/exportar-vendas-em-csv"},{"title":"Reembolsar uma venda","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/transactions/{transactionId}/refund","href":"/api-reference/vendas/reembolsar-uma-venda"}]},{"group":"Assinaturas","pages":[{"title":"Iniciar assinatura","openapi":"openapi-transacional.yaml POST /v1/subscriptions","href":"/api-reference/assinaturas-criar"},{"title":"Listar assinaturas","openapi":"openapi-transacional.yaml GET /v1/subscriptions","href":"/api-reference/assinaturas-listar"},{"title":"Consultar assinatura","openapi":"openapi-transacional.yaml GET /v1/subscriptions/{subscriptionId}","href":"/api-reference/assinaturas-consultar"},{"title":"Cancelar assinatura","openapi":"openapi-transacional.yaml POST /v1/subscriptions/{subscriptionId}/cancel","href":"/api-reference/assinaturas-cancelar"}]},{"group":"Clientes","pages":[{"title":"Listar clientes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers","href":"/api-reference/vendas/listar-clientes"},{"title":"Cadastrar um cliente","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/customers","href":"/api-reference/vendas/cadastrar-um-cliente"},{"title":"Consultar um cliente","description":"Devolve o cadastro de um cliente da empresa autenticada com contato, documento e endereço de entrega. Responde 404 quando o cliente não existe, foi excluído ou pertence a outra empresa.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/customers/{customerId}","href":"/api-reference/vendas/consultar-um-cliente"},{"title":"Atualizar um cliente","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/customers/{customerId}","href":"/api-reference/vendas/atualizar-um-cliente"}]},{"group":"Carrinhos abandonados","pages":[{"title":"Listar carrinhos abandonados","description":"Lista os pedidos que o comprador iniciou e não concluiu na empresa autenticada — com nome, documento, contato e os itens que ficaram no carrinho —, do mais recente para o mais antigo e com paginação. É o que alimenta uma régua de recuperação de carrinho por e-mail ou WhatsApp. Entram tanto quem nunca gerou transação quanto quem tem transação pendente de pagamento.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/order-drafts","href":"/api-reference/checkout/listar-carrinhos-abandonados"}]},{"group":"Reembolsos","pages":[{"title":"Listar solicitações de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/refund-requests","href":"/api-reference/reembolsos/listar-solicitações-de-reembolso"},{"title":"Exportar solicitações de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/refund-requests/export","href":"/api-reference/reembolsos/exportar-solicitações-de-reembolso"},{"title":"Aprovar reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/refund-requests/{refundRequestId}/approve","href":"/api-reference/reembolsos/aprovar-reembolso"},{"title":"Recusar reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/refund-requests/{refundRequestId}/reject","href":"/api-reference/reembolsos/recusar-reembolso"},{"title":"Listar respostas do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/refund-quiz-attempts","href":"/api-reference/reembolsos/listar-respostas-do-quiz-de-reembolso"},{"title":"Consultar resposta do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/refund-quiz-attempts/{attemptId}","href":"/api-reference/reembolsos/consultar-resposta-do-quiz-de-reembolso"},{"title":"Consultar a configuração de reembolso do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/refund-settings","href":"/api-reference/reembolsos/consultar-a-configuração-de-reembolso-do-produto"},{"title":"Atualizar a configuração de reembolso do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/products/{productId}/refund-settings","href":"/api-reference/reembolsos/atualizar-a-configuração-de-reembolso-do-produto"},{"title":"Consultar as perguntas do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/refund-quiz/questions","href":"/api-reference/reembolsos/consultar-as-perguntas-do-quiz-de-reembolso"},{"title":"Criar pergunta no quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/refund-quiz/questions","href":"/api-reference/reembolsos/criar-pergunta-no-quiz-de-reembolso"},{"title":"Reordenar as perguntas do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/products/{productId}/refund-quiz/questions/order","href":"/api-reference/reembolsos/reordenar-as-perguntas-do-quiz-de-reembolso"},{"title":"Atualizar pergunta do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/products/{productId}/refund-quiz/questions/{questionId}","href":"/api-reference/reembolsos/atualizar-pergunta-do-quiz-de-reembolso"},{"title":"Excluir pergunta do quiz de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}/refund-quiz/questions/{questionId}","href":"/api-reference/reembolsos/excluir-pergunta-do-quiz-de-reembolso"},{"title":"Baixar o comprovante de reembolso","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/transactions/{transactionId}/refund-receipt","href":"/api-reference/vendas/baixar-o-comprovante-de-reembolso"}]},{"group":"Infrações","pages":[{"title":"Listar infrações e disputas","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/infractions","href":"/api-reference/reembolsos/listar-infrações-e-disputas"}]},{"group":"Webhooks","pages":[{"title":"Listar webhooks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhooks","href":"/api-reference/plataforma/listar-webhooks"},{"title":"Criar webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/webhooks","href":"/api-reference/plataforma/criar-webhook"},{"title":"Consultar webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhooks/{webhookId}","href":"/api-reference/plataforma/consultar-webhook"},{"title":"Atualizar webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/webhooks/{webhookId}","href":"/api-reference/plataforma/atualizar-webhook"},{"title":"Excluir webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/webhooks/{webhookId}","href":"/api-reference/plataforma/excluir-webhook"},{"title":"Testar webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/webhooks/{webhookId}/test","href":"/api-reference/plataforma/testar-webhook"},{"group":"Entregas","pages":[{"title":"Listar entregas de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook-deliveries","href":"/api-reference/plataforma/listar-entregas-de-webhook"},{"title":"Consultar entrega de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook-deliveries/{deliveryId}","href":"/api-reference/plataforma/consultar-entrega-de-webhook"},{"title":"Reenviar webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/webhook-deliveries/{deliveryId}/retry","href":"/api-reference/plataforma/reenviar-webhook"}]},{"group":"Supressões","pages":[{"title":"Listar supressões de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhook-suppressions","href":"/api-reference/plataforma/listar-supressões-de-webhook"},{"title":"Criar supressão de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/webhook-suppressions","href":"/api-reference/plataforma/criar-supressão-de-webhook"},{"title":"Atualizar supressão de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/webhook-suppressions/{suppressionId}","href":"/api-reference/plataforma/atualizar-supressão-de-webhook"},{"title":"Remover supressão de webhook","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/webhook-suppressions/{suppressionId}","href":"/api-reference/plataforma/remover-supressão-de-webhook"}]}]},{"group":"Produtos","pages":[{"title":"Listar produtos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products","href":"/api-reference/catálogo/listar-produtos"},{"title":"Criar um produto já pronto para vender","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/v2","href":"/api-reference/catálogo/criar-um-produto-já-pronto-para-vender"},{"title":"Consultar um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}","href":"/api-reference/catálogo/consultar-um-produto"},{"title":"Atualizar um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/products/{productId}","href":"/api-reference/catálogo/atualizar-um-produto"},{"title":"Excluir um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}","href":"/api-reference/catálogo/excluir-um-produto"},{"title":"Remover o conteúdo entregue do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}/content","href":"/api-reference/catálogo/remover-o-conteúdo-entregue-do-produto"},{"title":"Remover a imagem de capa do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}/image","href":"/api-reference/catálogo/remover-a-imagem-de-capa-do-produto"},{"title":"Consultar as mensagens automáticas do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/message-template","href":"/api-reference/catálogo/consultar-as-mensagens-automáticas-do-produto"},{"title":"Configurar as mensagens automáticas do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/products/{productId}/message-template","href":"/api-reference/catálogo/configurar-as-mensagens-automáticas-do-produto"},{"title":"Publicar um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/publish","href":"/api-reference/catálogo/publicar-um-produto"},{"title":"Listar categorias de produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-categories","href":"/api-reference/catálogo/listar-categorias-de-produto"}]},{"group":"Pastas de produtos","pages":[{"title":"Consultar pastas de produtos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/product-folders","href":"/api-reference/catálogo/consultar-pastas-de-produtos"},{"title":"Criar pasta de produtos","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/product-folders","href":"/api-reference/catálogo/criar-pasta-de-produtos"},{"title":"Renomear pasta de produtos","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/product-folders/{folderId}","href":"/api-reference/catálogo/renomear-pasta-de-produtos"},{"title":"Excluir pasta de produtos","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/product-folders/{folderId}","href":"/api-reference/catálogo/excluir-pasta-de-produtos"},{"title":"Mover produtos de pasta","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/product-folders/move","href":"/api-reference/catálogo/mover-produtos-de-pasta"}]},{"group":"Ofertas","pages":[{"title":"Listar as ofertas da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/offers","href":"/api-reference/catálogo/listar-as-ofertas-da-empresa"},{"title":"Criar um plano de assinatura","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/offer-plans","href":"/api-reference/catálogo/criar-um-plano-de-assinatura"},{"title":"Listar as ofertas de um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/offers","href":"/api-reference/catálogo/listar-as-ofertas-de-um-produto"},{"title":"Criar uma oferta de pagamento único","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/offers","href":"/api-reference/catálogo/criar-uma-oferta-de-pagamento-único"},{"title":"Alternar entre preço único e assinatura","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/products/{productId}/offers/active-group","href":"/api-reference/catálogo/alternar-entre-preço-único-e-assinatura"},{"title":"Consultar uma oferta","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/offers/{offerId}","href":"/api-reference/catálogo/consultar-uma-oferta"},{"title":"Atualizar uma oferta","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/products/{productId}/offers/{offerId}","href":"/api-reference/catálogo/atualizar-uma-oferta"},{"title":"Excluir uma oferta","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}/offers/{offerId}","href":"/api-reference/catálogo/excluir-uma-oferta"}]},{"group":"Checkouts","pages":[{"title":"Criar checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/checkouts","href":"/api-reference/checkout/criar-checkout"},{"title":"Consultar checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/checkouts/{checkoutId}","href":"/api-reference/checkout/consultar-checkout"},{"title":"Atualizar checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/checkouts/{checkoutId}","href":"/api-reference/checkout/atualizar-checkout"},{"title":"Excluir checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/checkouts/{checkoutId}","href":"/api-reference/checkout/excluir-checkout"},{"title":"Definir ofertas do checkout","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/checkouts/{checkoutId}/offers","href":"/api-reference/checkout/definir-ofertas-do-checkout"},{"title":"Listar checkouts de um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/checkouts","href":"/api-reference/checkout/listar-checkouts-de-um-produto"},{"title":"Listar links de venda do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/links","href":"/api-reference/checkout/listar-links-de-venda-do-produto"}]},{"group":"Order bumps","pages":[{"title":"Listar order bumps","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/order-bumps","href":"/api-reference/catálogo/listar-order-bumps"},{"title":"Criar um order bump","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/order-bumps","href":"/api-reference/catálogo/criar-um-order-bump"},{"title":"Consultar um order bump","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/order-bumps/{orderBumpId}","href":"/api-reference/catálogo/consultar-um-order-bump"},{"title":"Atualizar um order bump","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/order-bumps/{orderBumpId}","href":"/api-reference/catálogo/atualizar-um-order-bump"},{"title":"Excluir um order bump","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/order-bumps/{orderBumpId}","href":"/api-reference/catálogo/excluir-um-order-bump"}]},{"group":"Upsell","pages":[{"title":"Consultar o upsell do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/upsell","href":"/api-reference/catálogo/consultar-o-upsell-do-produto"},{"title":"Configurar o upsell do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/products/{productId}/upsell","href":"/api-reference/catálogo/configurar-o-upsell-do-produto"}]},{"group":"Cupons","pages":[{"title":"Listar cupons","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/coupons","href":"/api-reference/catálogo/listar-cupons"},{"title":"Criar um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/coupons","href":"/api-reference/catálogo/criar-um-cupom"},{"title":"Consultar um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/coupons/{couponId}","href":"/api-reference/catálogo/consultar-um-cupom"},{"title":"Atualizar um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/coupons/{couponId}","href":"/api-reference/catálogo/atualizar-um-cupom"},{"title":"Excluir um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/coupons/{couponId}","href":"/api-reference/catálogo/excluir-um-cupom"},{"title":"Ativar ou desativar um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/coupons/{couponId}/active","href":"/api-reference/catálogo/ativar-ou-desativar-um-cupom"},{"title":"Vincular ofertas a um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/coupons/{couponId}/offers","href":"/api-reference/catálogo/vincular-ofertas-a-um-cupom"},{"title":"Desvincular uma oferta de um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/coupons/{couponId}/offers/{offerId}","href":"/api-reference/catálogo/desvincular-uma-oferta-de-um-cupom"},{"title":"Vincular produtos a um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/coupons/{couponId}/products","href":"/api-reference/catálogo/vincular-produtos-a-um-cupom"},{"title":"Desvincular um produto de um cupom","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/coupons/{couponId}/products/{productId}","href":"/api-reference/catálogo/desvincular-um-produto-de-um-cupom"},{"title":"Listar os cupons que valem para um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/coupons","href":"/api-reference/catálogo/listar-os-cupons-que-valem-para-um-produto"},{"title":"Listar os cupons que ainda podem ser vinculados ao produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/eligible-coupons","href":"/api-reference/catálogo/listar-os-cupons-que-ainda-podem-ser-vinculados-ao-produto"}]},{"group":"Pixels","pages":[{"title":"Listar provedores de pixel","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/pixel-providers","href":"/api-reference/checkout/listar-provedores-de-pixel"},{"title":"Listar pixels de rastreamento","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/pixels","href":"/api-reference/checkout/listar-pixels-de-rastreamento"},{"title":"Adicionar pixel de rastreamento","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/pixels","href":"/api-reference/checkout/adicionar-pixel-de-rastreamento"},{"title":"Remover pixel de rastreamento","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/pixels/{pixelId}","href":"/api-reference/checkout/remover-pixel-de-rastreamento"}]},{"group":"Área de membros","pages":[{"group":"Cursos","pages":[{"title":"Listar cursos da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/member-courses","href":"/api-reference/catálogo/listar-cursos-da-empresa"},{"title":"Criar curso em rascunho","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses","href":"/api-reference/catálogo/criar-curso-em-rascunho"},{"title":"Obter curso e seu conteúdo","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/member-courses/{courseId}","href":"/api-reference/catálogo/obter-curso-e-seu-conteúdo"},{"title":"Editar ou publicar curso","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/member-courses/{courseId}","href":"/api-reference/catálogo/editar-ou-publicar-curso"},{"title":"Excluir curso e seus dependentes","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}","href":"/api-reference/catálogo/excluir-curso-e-seus-dependentes"},{"title":"Remover capa do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/cover","href":"/api-reference/catálogo/remover-capa-do-curso"},{"title":"Finalizar capa do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/cover/finalize","href":"/api-reference/catálogo/finalizar-capa-do-curso"},{"title":"Solicitar upload da capa do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/cover/upload","href":"/api-reference/catálogo/solicitar-upload-da-capa-do-curso"},{"title":"Solicitar upload do logo do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/logo/upload","href":"/api-reference/catálogo/solicitar-upload-do-logo-do-curso"},{"title":"Finalizar logo do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/logo/finalize","href":"/api-reference/catálogo/finalizar-logo-do-curso"},{"title":"Remover logo do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/logo","href":"/api-reference/catálogo/remover-logo-do-curso"}]},{"group":"Módulos e aulas","pages":[{"title":"Editar aula","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/member-courses/{courseId}/lessons/{lessonId}","href":"/api-reference/catálogo/editar-aula"},{"title":"Excluir aula e seus dependentes","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/lessons/{lessonId}","href":"/api-reference/catálogo/excluir-aula-e-seus-dependentes"},{"title":"Remover imagem da aula","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/lessons/{lessonId}/image","href":"/api-reference/catálogo/remover-imagem-da-aula"},{"title":"Finalizar imagem da aula","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/image/finalize","href":"/api-reference/catálogo/finalizar-imagem-da-aula"},{"title":"Solicitar upload da imagem da aula","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/image/upload","href":"/api-reference/catálogo/solicitar-upload-da-imagem-da-aula"},{"title":"Adicionar módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/modules","href":"/api-reference/catálogo/adicionar-módulo"},{"title":"Definir ordem completa dos módulos","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/member-courses/{courseId}/modules/order","href":"/api-reference/catálogo/definir-ordem-completa-dos-módulos"},{"title":"Editar módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/member-courses/{courseId}/modules/{moduleId}","href":"/api-reference/catálogo/editar-módulo"},{"title":"Excluir módulo e suas aulas","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/modules/{moduleId}","href":"/api-reference/catálogo/excluir-módulo-e-suas-aulas"},{"title":"Adicionar aula ao módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/modules/{moduleId}/lessons","href":"/api-reference/catálogo/adicionar-aula-ao-módulo"},{"title":"Definir ordem completa das aulas do módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/member-courses/{courseId}/modules/{moduleId}/lessons/order","href":"/api-reference/catálogo/definir-ordem-completa-das-aulas-do-módulo"},{"title":"Duplicar módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/modules/{moduleId}/duplicate","href":"/api-reference/catálogo/duplicar-módulo"},{"title":"Solicitar upload da capa do módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/modules/{moduleId}/cover/upload","href":"/api-reference/catálogo/solicitar-upload-da-capa-do-módulo"},{"title":"Finalizar capa do módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/modules/{moduleId}/cover/finalize","href":"/api-reference/catálogo/finalizar-capa-do-módulo"},{"title":"Remover capa do módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/modules/{moduleId}/cover","href":"/api-reference/catálogo/remover-capa-do-módulo"},{"title":"Duplicar aula","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/duplicate","href":"/api-reference/catálogo/duplicar-aula"},{"title":"Mover aula para outro módulo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/move","href":"/api-reference/catálogo/mover-aula-para-outro-módulo"}]},{"group":"Materiais","pages":[{"title":"Adicionar material à aula","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/materials","href":"/api-reference/catálogo/adicionar-material-à-aula"},{"title":"Definir ordem completa dos materiais","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/member-courses/{courseId}/lessons/{lessonId}/materials/order","href":"/api-reference/catálogo/definir-ordem-completa-dos-materiais"},{"title":"Editar material","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/member-courses/{courseId}/lessons/{lessonId}/materials/{materialId}","href":"/api-reference/catálogo/editar-material"},{"title":"Excluir material","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/lessons/{lessonId}/materials/{materialId}","href":"/api-reference/catálogo/excluir-material"}]},{"group":"Comentários","pages":[{"title":"Listar comentários da aula para moderação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/member-courses/{courseId}/lessons/{lessonId}/comments","href":"/api-reference/catálogo/listar-comentários-da-aula-para-moderação"},{"title":"Publicar comentário da equipe do curso","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/member-courses/{courseId}/lessons/{lessonId}/comments","href":"/api-reference/catálogo/publicar-comentário-da-equipe-do-curso"},{"title":"Editar comentário da equipe","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/member-courses/{courseId}/lessons/{lessonId}/comments/{commentId}","href":"/api-reference/catálogo/editar-comentário-da-equipe"},{"title":"Moderar removendo comentário","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/member-courses/{courseId}/lessons/{lessonId}/comments/{commentId}","href":"/api-reference/catálogo/moderar-removendo-comentário"}]},{"group":"Matrículas","pages":[{"title":"Listar matrículas ativas do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/member-enrollments","href":"/api-reference/catálogo/listar-matrículas-ativas-do-produto"},{"title":"Conceder matrícula manual ao produto","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/member-enrollments","href":"/api-reference/catálogo/conceder-matrícula-manual-ao-produto"},{"title":"Revogar somente matrícula manual","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/products/{productId}/member-enrollments/{enrollmentId}","href":"/api-reference/catálogo/revogar-somente-matrícula-manual"}]}]},{"group":"Afiliados","pages":[{"title":"Listar afiliados","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/affiliates","href":"/api-reference/crescimento/listar-afiliados"},{"title":"Aprovar ou bloquear afiliado","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/affiliates/{affiliateId}","href":"/api-reference/crescimento/aprovar-ou-bloquear-afiliado"},{"title":"Solicitar afiliação a um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/affiliations","href":"/api-reference/crescimento/solicitar-afiliação-a-um-produto"},{"title":"Consultar relatório de vendas de afiliação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/affiliations/sales-report","href":"/api-reference/crescimento/consultar-relatório-de-vendas-de-afiliação"},{"title":"Listar links de afiliação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/affiliations/{affiliationId}/links","href":"/api-reference/crescimento/listar-links-de-afiliação"},{"title":"Listar pixels da afiliação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/affiliations/{affiliationId}/pixels","href":"/api-reference/crescimento/listar-pixels-da-afiliação"},{"title":"Substituir os pixels da afiliação","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/affiliations/{affiliationId}/pixels","href":"/api-reference/crescimento/substituir-os-pixels-da-afiliação"},{"title":"Consultar programa de afiliados do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/affiliation-settings","href":"/api-reference/crescimento/consultar-programa-de-afiliados-do-produto"},{"title":"Configurar programa de afiliados do produto","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/products/{productId}/affiliation-settings","href":"/api-reference/crescimento/configurar-programa-de-afiliados-do-produto"},{"title":"Simular comissão de afiliado","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/affiliation-settings/commission-preview","href":"/api-reference/crescimento/simular-comissão-de-afiliado"},{"title":"Definir comissão de um afiliado","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/affiliates/{affiliateId}/commission","href":"/api-reference/crescimento/definir-comissão-de-um-afiliado"}]},{"group":"Coprodução","pages":[{"title":"Listar coproduções","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/co-productions","href":"/api-reference/crescimento/listar-coproduções"},{"title":"Atualizar coproducao","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/co-productions/{coProductionId}","href":"/api-reference/crescimento/atualizar-coproducao"},{"title":"Aceitar convite de coprodução","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/co-productions/{coProductionId}/accept","href":"/api-reference/crescimento/aceitar-convite-de-coprodução"},{"title":"Cancelar convite de coprodução","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/co-productions/{coProductionId}/cancel","href":"/api-reference/crescimento/cancelar-convite-de-coprodução"},{"title":"Recusar convite de coprodução","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/co-productions/{coProductionId}/reject","href":"/api-reference/crescimento/recusar-convite-de-coprodução"},{"title":"Listar coproduções de um produto","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/products/{productId}/co-productions","href":"/api-reference/crescimento/listar-coproduções-de-um-produto"},{"title":"Convidar coprodutor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/products/{productId}/co-productions","href":"/api-reference/crescimento/convidar-coprodutor"}]},{"group":"Marketplace","pages":[{"title":"Listar produtos do marketplace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/products","href":"/api-reference/crescimento/listar-produtos-do-marketplace"},{"title":"Consultar produto do marketplace","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/marketplace/products/{productId}","href":"/api-reference/crescimento/consultar-produto-do-marketplace"}]},{"group":"Integrações","pages":[{"title":"Listar cargos do servidor Discord","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/integrations/discord/guilds/{guildId}/roles","href":"/api-reference/plataforma/listar-cargos-do-servidor-discord"},{"title":"Listar turmas da Memberkit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/integrations/memberkit/{integrationId}/classrooms","href":"/api-reference/plataforma/listar-turmas-da-memberkit"},{"title":"Listar integrações de um aplicativo","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/integrations/{provider}","href":"/api-reference/plataforma/listar-integrações-de-um-aplicativo"},{"title":"Conectar integração","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/integrations/{provider}","href":"/api-reference/plataforma/conectar-integração"},{"title":"Vincular canal de comunidade","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/integrations/{provider}/channels","href":"/api-reference/plataforma/vincular-canal-de-comunidade"},{"title":"Atualizar status do canal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/integrations/{provider}/channels/refresh","href":"/api-reference/plataforma/atualizar-status-do-canal"},{"title":"Listar produtos vinculados ao canal","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/integrations/{provider}/channels/{channelId}/products","href":"/api-reference/plataforma/listar-produtos-vinculados-ao-canal"},{"title":"Vincular produto ao canal","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/integrations/{provider}/channels/{channelId}/products","href":"/api-reference/plataforma/vincular-produto-ao-canal"},{"title":"Desvincular produto do canal","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/integrations/{provider}/channels/{channelId}/products/{mappingId}","href":"/api-reference/plataforma/desvincular-produto-do-canal"},{"title":"Atualizar integração","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/integrations/{provider}/{integrationId}","href":"/api-reference/plataforma/atualizar-integração"},{"title":"Desconectar integração","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/integrations/{provider}/{integrationId}","href":"/api-reference/plataforma/desconectar-integração"},{"title":"Ativar ou pausar integração","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /v1/integrations/{provider}/{integrationId}/active","href":"/api-reference/plataforma/ativar-ou-pausar-integração"}]},{"group":"Saldo e extrato","pages":[{"title":"Listar lançamentos do extrato","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/balance-operations","href":"/api-reference/financeiro/listar-lançamentos-do-extrato"},{"title":"Listar totais do extrato por tipo","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/balance-operations/by-type","href":"/api-reference/financeiro/listar-totais-do-extrato-por-tipo"},{"title":"Consultar saldo","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/balance","href":"/api-reference/financeiro/consultar-saldo"},{"title":"Listar valores bloqueados","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/blocked-amounts","href":"/api-reference/financeiro/listar-valores-bloqueados"},{"title":"Consultar taxas da conta","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/fees","href":"/api-reference/financeiro/consultar-taxas-da-conta"},{"title":"Consultar o adicional de juros por parcela","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/fees/installment-interest","href":"/api-reference/financeiro/consultar-o-adicional-de-juros-por-parcela"},{"title":"Configurar o adicional de juros por parcela","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/fees/installment-interest","href":"/api-reference/financeiro/configurar-o-adicional-de-juros-por-parcela"}]},{"group":"Saques","pages":[{"title":"Consultar conta bancária de recebimento","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/bank-account","href":"/api-reference/financeiro/consultar-conta-bancária-de-recebimento"},{"title":"Cadastrar conta bancária de recebimento","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/bank-account","href":"/api-reference/financeiro/cadastrar-conta-bancária-de-recebimento"},{"title":"Consultar chave Pix de saque","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/pix-key","href":"/api-reference/financeiro/consultar-chave-pix-de-saque"},{"title":"Listar saques","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/transfers","href":"/api-reference/financeiro/listar-saques"},{"title":"Solicitar saque","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/transfers","href":"/api-reference/financeiro/solicitar-saque"},{"title":"Consultar saque","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/transfers/{transferId}","href":"/api-reference/financeiro/consultar-saque"}]},{"group":"Antecipação","pages":[{"title":"Listar antecipações","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/anticipations","href":"/api-reference/financeiro/listar-antecipações"},{"title":"Solicitar antecipação","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/anticipations","href":"/api-reference/financeiro/solicitar-antecipação"},{"title":"Consultar antecipação disponível","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/anticipations/summary","href":"/api-reference/financeiro/consultar-antecipação-disponível"}]},{"group":"Dashboard e relatórios","pages":[{"title":"Consultar pagos e reembolsados","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/dashboard/paid-and-refunded","href":"/api-reference/crescimento/consultar-pagos-e-reembolsados"},{"title":"Consultar resumo do dashboard","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/dashboard/summary","href":"/api-reference/crescimento/consultar-resumo-do-dashboard"},{"title":"Consultar relatório de aprovação de cartão","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/card-approval","href":"/api-reference/crescimento/consultar-relatório-de-aprovação-de-cartão"},{"title":"Consultar relatório de conversão","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/conversion","href":"/api-reference/crescimento/consultar-relatório-de-conversão"},{"title":"Consultar relatório de pagamentos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/payment","href":"/api-reference/crescimento/consultar-relatório-de-pagamentos"},{"title":"Consultar relatório de performance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/performance","href":"/api-reference/crescimento/consultar-relatório-de-performance"},{"title":"Consultar relatório de risco","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/risk","href":"/api-reference/crescimento/consultar-relatório-de-risco"},{"title":"Consultar relatório de escala","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/reports/scale","href":"/api-reference/crescimento/consultar-relatório-de-escala"}]},{"group":"Empresa","pages":[{"title":"Consultar dados da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/company","href":"/api-reference/plataforma/consultar-dados-da-empresa"},{"title":"Atualizar endereço da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/company/address","href":"/api-reference/plataforma/atualizar-endereço-da-empresa"},{"title":"Atualizar marca da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/company/branding","href":"/api-reference/plataforma/atualizar-marca-da-empresa"},{"title":"Consultar documentos da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/company/documents","href":"/api-reference/plataforma/consultar-documentos-da-empresa"},{"title":"Enviar documentos da empresa","deprecated":null,"version":null,"openapi":"/openapi.yaml put /v1/company/documents","href":"/api-reference/plataforma/enviar-documentos-da-empresa"},{"title":"Consultar pendências da conta","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/subaccount-status","href":"/api-reference/plataforma/consultar-pendências-da-conta"},{"title":"Reprocessar pendências da conta","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/subaccount-status/resolve","href":"/api-reference/plataforma/reprocessar-pendências-da-conta"}]},{"group":"Chaves de API e time","pages":[{"title":"Listar chaves de API","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/api-keys","href":"/api-reference/plataforma/listar-chaves-de-api"},{"title":"Listar membros da equipe","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/team-members","href":"/api-reference/plataforma/listar-membros-da-equipe"},{"title":"Consultar convite de equipe","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/team-members/invites/{inviteToken}","href":"/api-reference/plataforma/consultar-convite-de-equipe"}]},{"group":"Indicações e recompensas","pages":[{"title":"Listar bônus de indicação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/referrals/bonuses","href":"/api-reference/crescimento/listar-bônus-de-indicação"},{"title":"Consultar link de indicação","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/referrals/link","href":"/api-reference/crescimento/consultar-link-de-indicação"},{"title":"Consultar nível de recompensa","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/rewards/tier","href":"/api-reference/crescimento/consultar-nível-de-recompensa"},{"title":"Listar itens do roadmap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/roadmap-items","href":"/api-reference/crescimento/listar-itens-do-roadmap"},{"title":"Sugerir item no roadmap","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/roadmap-items","href":"/api-reference/crescimento/sugerir-item-no-roadmap"}]}]}]},"basePath":"","title":"Atualizar um cliente - Ephra","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-CYZot51e.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}