Skip to main content
PUT
Update a recipient

Authorizations

x-api-key
string
header
required

Headers

x-idempotency-key
string<uuid>
required

Unique key (UUID) to ensure request idempotency on POST, PUT and PATCH requests.

A key is scoped to your client, the HTTP method and the path, and is remembered for 24 hours after a successful (below 400) response. Repeating the same request (same JSON body, whatever the key order or whitespace) with the same key within that window returns the original response with X-Idempotent-Replayed: true instead of executing the request again. Using the same key on the same endpoint with a different body returns 422 with problem type idempotency-key-reused; the request is not executed. Error responses (4xx and 5xx) are not remembered, so a request refused for a fixable reason can be corrected and retried under the same key. Request bodies that are not JSON (for example file uploads) are not compared.

Path Parameters

recipient_id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

Body

application/json

Updated recipient details

Request for creating or updating a recipient entity.

Address Requirements:

  • Optional for crypto-only recipients (can be omitted or null)
  • Required before adding fiat destinations (ACH, Wire, SWIFT)

Migration Path: Recipients created without addresses can be updated later to add an address when fiat capabilities are needed.

name
string
required

Name of the recipient entity

Required string length: 3 - 140
Example:

"Acme Corporation"

address
Address · object

Physical address of the recipient.

  • Optional when creating/updating crypto-only recipients
  • Required for recipients that will have fiat destinations (ACH, Wire, SWIFT)
  • Can be added later via PUT /recipients/{id} to enable fiat capabilities
external_id
string

Your own label for this recipient in your system, used to look it up with the external_id filter on GET /customers/{customer_id}/recipients. Not unique: Dakota does not reject a duplicate, and several recipients can share one value. On PUT /recipients/{recipient_id}, omit it to leave the current value unchanged; it cannot be cleared.

Maximum string length: 255
Pattern: ^[^\x00-\x1f]*$
Example:

"vendor-1177"

Response

Recipient updated successfully

Response containing recipient details.

id
string
required

KSUID is a 27-character globally unique ID that combines a timestamp with a random component. Used for all entity identifiers in the Dakota platform.

Required string length: 27
Pattern: ^[0-9A-Za-z]{27}$
Example:

"1NFHrqBHb3cTfLVkFSGmHZqdDPi"

name
string
required

Name of the recipient entity.

Example:

"Acme Corporation"

status
enum<string>
required

Current status of the recipient

Available options:
unused,
active,
frozen
Example:

"active"

external_id
string

Your own label for this recipient in your system, used to look it up with the external_id filter on GET /customers/{customer_id}/recipients. Not unique: Dakota does not reject a duplicate, and several recipients can share one value. Omitted when none was set.

Example:

"vendor-1177"

address
Address · object | null

Standardized physical address format used throughout the Dakota platform for user and entity addresses.

destinations
Crypto Destination Response · object · Crypto Destination Response · object · Crypto Destination Response · object · US Fiat Destination Response · object · IBAN Fiat Destination Response · object[]

List of destinations associated with this recipient.

Response for a crypto destination.