Modify a recipient

curl --request PATCH \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "nickname": "sample nickname",
    "email": "satoshi@circle.com",
    "bns": "sample.circle"
  }
}
'

{
  "data": {
    "chain": "ALGO",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "metadata": {
      "nickname": "sample nickname",
      "email": "satoshi@circle.com",
      "bns": "sample.circle"
    },
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "addressTag": "123456789",
    "status": "pending",
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

PATCH

addressBook

recipients

{id}

Modify a recipient

curl --request PATCH \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "nickname": "sample nickname",
    "email": "satoshi@circle.com",
    "bns": "sample.circle"
  }
}
'

{
  "data": {
    "chain": "ALGO",
    "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
    "metadata": {
      "nickname": "sample nickname",
      "email": "satoshi@circle.com",
      "bns": "sample.circle"
    },
    "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
    "addressTag": "123456789",
    "status": "pending",
    "createDate": "2020-04-10T02:13:30.000Z",
    "updateDate": "2020-04-10T02:13:30.000Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json

metadata

object

Show child attributes

metadata.nickname

string

Nickname related to the address.

Example:

"sample nickname"

metadata.email

string

Email of the user.

Maximum string length: 1024

Example:

"satoshi@circle.com"

metadata.bns

string

Blockchain Name Service (e.g. ENS) domain for the address.

Example:

"sample.circle"

Response

Successfully updated the address book recipient.

data

object

Show child attributes

data.chain

enum<string>

required

A blockchain that a given currency is available on.

Available options:

ALGO,

APTOS,

ARB,

AVAX,

BASE,

BTC,

CELO,

CODEX,

ETH,

HBAR,

HYPEREVM,

INK,

LINEA,

NEAR,

NOBLE,

OP,

PLUME,

PAH,

POLY,

SEI,

SOL,

SONIC,

SUI,

UNI,

WORLDCHAIN,

XDC,

XLM,

XRP,

ZKS,

ZKSYNC

data.address

string

required

An alphanumeric string representing a blockchain address. Formatting varies by blockchain. Be sure to preserve the exact formatting and capitalization of the address.
Important: For Ripple (XRP) addresses, only the classic address format is supported (for example, rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY).
The x-address format is NOT supported currently (for example, XV5sbjUmgPpvXv4ixFWZ5ptAYZ6PD2q1qM6owqNbug8W6KV).

Example:

"0x8381470ED67C3802402dbbFa0058E8871F017A6F"

data.metadata

object

required

Show child attributes

data.metadata.nickname

string

Nickname related to the address.

Example:

"sample nickname"

data.metadata.email

string

Email of the user.

Maximum string length: 1024

Example:

"satoshi@circle.com"

data.metadata.bns

string

Blockchain Name Service (e.g. ENS) domain for the address.

Example:

"sample.circle"

data.id

string<uuid>

Unique system generated identifier for the entity.

Example:

"b8627ae8-732b-4d25-b947-1df8f4007a29"

data.addressTag

string | null

The secondary identifier for a blockchain address. An example of this is the memo field on the Stellar network, which can be text, id, or hash format.

Example:

"123456789"

data.status

enum<string>

Status of the address book recipient.

Available options:

pending,

inactive,

active,

denied

data.createDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

data.updateDate

string

ISO-8601 UTC date/time format.

Example:

"2020-04-10T02:13:30.000Z"

Get a recipient

Delete a recipient

Core API

API Overview

Core API for Institutions

Crypto Deposits API

Crypto Payouts API

Cross-Currency API

Reserve Management API

Modify a recipient

Authorizations

Path Parameters

Body

Response