Circle Account Setup

PATCH 
/organization/circle-config

Updates the Circle configuration for the organization. Only account owners have permission to do this. Note: in the first time configuration, all fields are mandatory, but after it is been configured at least once, you can replace a single field at a time.

Request

application/json

Body

required

Circle configuration to be updated

api_key string

The Circle API key with permissions to POST & GET transfers

wallet_id string

The ID of the Circle walet from where the funds will be sent

Responses

200

Circle configuration updated successfully

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Circle configuration updated"
}

400

Bad Request

application/json

Schema

Schema

error string

Details about the error

extras

object

object

Example (from schema)

{
  "error": "Invalid input",
  "extras": {
    "field_foo": "field_foo is required",
    "field_bar": "field_bar needs to be an integer"
  }
}

Loading...