Skip to main content
POST
/
subaccount
/
portal
/
update-email
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/portal/update-email' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "clx_subconta",
    "email": "novo@empresa.com"
  }'

{
  "success": true,
  "message": "Pagamento PIX criado com sucesso",
  "data": {},
  "requestId": "<string>"
}
curl -X POST 'https://api.goatpay.com.br/v1/subaccount/portal/update-email' \
  -H 'X-API-Key: gp_live_SUA_CHAVE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "clx_subconta",
    "email": "novo@empresa.com"
  }'
​
id
string
ID da subconta. Informe id ou externalReference.
​
externalReference
string
Referência externa da subconta.
​
email
string
required
Novo e-mail de login.
Permissão: subaccount/portal/update-email. Sem nova confirmação por e-mail.

Authorizations

​
X-API-Key
string
header
required

Chave gp_live_... criada em Integrações → Chaves de API no dashboard.

Body

application/json

Informe id ou externalReference da subconta.

​
email
string<email>
required
​
id
string
​
externalReference
string
Maximum string length: 64

Response

200 - application/json

Operação concluída.

​
success
boolean
required
Example:

true

​
message
string
required
Example:

"Pagamento PIX criado com sucesso"

​
data
object
required
​
requestId
string