Skip to main content
PATCH
Update a contract

Authorizations

Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are required to make a successful request.

Headers

X-Request-Id
string<uuid>

Developer-provided identifier for this request, used for tracing requests in Wallets API logs and the Developer Console, and when communicating with Circle Support. Must be a UUID to appear in logs. Non-UUID values are accepted by the API but are ignored by logging and tracing systems.

A unique identifier, which can be helpful for identifying a request when communicating with Circle support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

id
string<uuid>
required

The universally unique identifier of the resource.

Example:

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

Body

application/json

Update contract properties request

name
string

The name for a contract. Must be alphanumeric [a-zA-Z0-9].

Example:

"First Contract"

description
string

The description for a contract.

Example:

"My first hello world contract"

archived
boolean

The archive state of the contract. If true, the contract will not be visible in your dashboard.

Example:

false

Response

Contract is updated.

data
object
required