Skip to main content
PUT
Update Payee

Headers

X-Api-Key
string
required

Your API Key (UUID format). Required to identify and authorize each request

X-Api-Secret
string
required

Secret associated with your API Key. Used for authenticating requests. Keep this secure.

Body

application/json
payee_id
string<uuid>
required

Unique identifier (UUID) assigned to the payee.

Example:

"f47ac10b-****-****-****-0e02b2c3d479"

name
string
required

Full name of the payee

Example:

"John Doe"

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data
ExternalContactsRead · object | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1778161546.973489

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400