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

Bodyrequired

Circle configuration to be updated

api_keystring

The Circle API key with permissions to POST & GET transfers

wallet_idstring

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

Responses

200

Circle configuration updated successfully

application/json

Schema

Schema

messagestring
Example: Circle configuration updated

Example (auto)

{
  "message": "Circle configuration updated"
}

400

Bad Request

application/json

Schema

Schema

errorstring
Details about the error
extras object
object

Example (auto)

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

Authorization: Authorization

name: Authorizationtype: apiKeydescription: JWT used for authentication, signed with an ES256 private key.in: header

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "/organization/circle-config");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "<Authorization>");
var content = new StringContent("{\n  \"api_key\": \"string\",\n  \"wallet_id\": \"string\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

Auth

BearerAuth

Body required

{
  "api_key": "string",
  "wallet_id": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!