Updates a third-party account holder

patch

https://api.sandbox.cuentamono.com/v1/ledger/account_holders/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

^[A-Za-z]{2,7}_[\w-]{22}$

Account Holder ID (Base 62 format)

Body Params

Attributes to update a third-party account holder

This entity is used to update the state of an account holder, it could be transitioned to active or blocked

detail

string | null

It provides a textual reason why the account holder is blocked in case of the state_reason value is other.

string

^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+){1,2}$

Account holder's email

metadata

object

A tenant-managed flat map for providing additional data about the account holder. The values are stored and displayed as strings, and the provided information will be returned as-is in the account holder details.

phone_number

string

^\+[1-9]\d{1,14}$

Account holder's phone number

reason

string | null

enum

It provides the reason why the account holder could be blocked. It is required when the account holder is transitioned to being blocked.

Allowed:

state

string

enum

It represents the current state of the account holder, and these are the possible states of an account holder:

active: it is enable to manage and perform actions with its accounts.
blocked: it is blocked by the tenant, but you could also make it active again.

Allowed:

Responses

Callback

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400400 Bad Request

401401 Unauthorized

403403 Forbidden

404404 Not Found

422422 Unprocessable Content