curl -X PATCH 'https://api.goatpay.com.br/v1/oauth-apps/update/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro v2",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"status": "ACTIVE"
}'
{
"success": true,
"message": "Aplicação OAuth atualizada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro v2",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"clients": []
}
},
"requestId": "req_oauth_update"
}
Gestão
Atualizar aplicação OAuth
Atualiza nome, metadados, scopes ou status da aplicação.
PATCH
/
oauth-apps
/
update
/
{id}
curl -X PATCH 'https://api.goatpay.com.br/v1/oauth-apps/update/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro v2",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"status": "ACTIVE"
}'
{
"success": true,
"message": "Aplicação OAuth atualizada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro v2",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"clients": []
}
},
"requestId": "req_oauth_update"
}
Permissão:
oauth-apps/update. Envie apenas os campos que deseja alterar.
curl -X PATCH 'https://api.goatpay.com.br/v1/oauth-apps/update/clx_app_01' \
-H 'X-API-Key: gp_live_SUA_CHAVE' \
-H 'Content-Type: application/json' \
-d '{
"name": "ERP Parceiro v2",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"status": "ACTIVE"
}'
{
"success": true,
"message": "Aplicação OAuth atualizada com sucesso",
"data": {
"item": {
"id": "clx_app_01",
"name": "ERP Parceiro v2",
"status": "ACTIVE",
"allowedScopes": ["account:read", "payments:read", "payments:write"],
"clients": []
}
},
"requestId": "req_oauth_update"
}
Parâmetros
string
required
ID da aplicação OAuth.
Corpo da requisição
string
Novo nome da aplicação.
string
Nova descrição.
string
URL do logo exibido no consentimento.
string
URL da política de privacidade.
string
URL dos termos de uso.
array
Novo conjunto de scopes permitidos.
string
ACTIVE ou DISABLED — apps desabilitadas não podem iniciar novos fluxos de authorize.string
URL do site.
string
Nome do desenvolvedor.
Authorizations
Chave gp_live_... criada em Integrações → Chaves de API no dashboard.
Path Parameters
ID do recurso (transação, cobrança, webhook, etc.)
Body
application/json