Update a custody account group
curl --request PUT \
--url https://api-sandbox.circle.com/v1/accounts/groups/{groupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Team A Renamed"
}
'import requests
url = "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}"
payload = { "name": "Team A Renamed" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Team A Renamed'})
};
fetch('https://api-sandbox.circle.com/v1/accounts/groups/{groupId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Team A Renamed'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}"
payload := strings.NewReader("{\n \"name\": \"Team A Renamed\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-sandbox.circle.com/v1/accounts/groups/{groupId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Team A Renamed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/accounts/groups/{groupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Team A Renamed\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e",
"name": "Team A",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z",
"approximateBalanceInUsd": {
"amount": "3.14",
"currency": "USD"
},
"accountsPreview": {
"totalCount": 15,
"accountNames": [
"Operations US",
"Reserve US",
"Treasury APAC",
"Treasury EU",
"Treasury US"
]
}
}
}{
"code": 2,
"message": "API parameter invalid."
}{
"code": 4,
"message": "Unauthorized."
}{
"code": 404,
"message": "Not found."
}{
"code": -1,
"message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}Update a custody account group
Renames a custody account group. The new name must be unique (case-insensitive) within the calling entity.
PUT
/
v1
/
accounts
/
groups
/
{groupId}
Update a custody account group
curl --request PUT \
--url https://api-sandbox.circle.com/v1/accounts/groups/{groupId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Team A Renamed"
}
'import requests
url = "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}"
payload = { "name": "Team A Renamed" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'Team A Renamed'})
};
fetch('https://api-sandbox.circle.com/v1/accounts/groups/{groupId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Team A Renamed'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.circle.com/v1/accounts/groups/{groupId}"
payload := strings.NewReader("{\n \"name\": \"Team A Renamed\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-sandbox.circle.com/v1/accounts/groups/{groupId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Team A Renamed\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.circle.com/v1/accounts/groups/{groupId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Team A Renamed\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e",
"name": "Team A",
"createDate": "2020-04-10T02:13:30.000Z",
"updateDate": "2020-04-10T02:13:30.000Z",
"approximateBalanceInUsd": {
"amount": "3.14",
"currency": "USD"
},
"accountsPreview": {
"totalCount": 15,
"accountNames": [
"Operations US",
"Reserve US",
"Treasury APAC",
"Treasury EU",
"Treasury US"
]
}
}
}{
"code": 2,
"message": "API parameter invalid."
}{
"code": 4,
"message": "Unauthorized."
}{
"code": 404,
"message": "Not found."
}{
"code": -1,
"message": "Something went wrong. errId: 1f0b0c455e40f753f07b4f0ae6abd4b4"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifier of the custody account group.
Example:
"9c0f1c0d-6c61-4f3d-9b8a-1a3a4b3c5d6e"
Body
application/json
New display name.
Required string length:
1 - 32Example:
"Team A Renamed"
Response
Successfully updated the custody account group.
A customer-defined grouping of custody accounts owned by a single entity. Each account can belong to at most one group at a time.
The approximateBalanceInUsd and accountsPreview fields are aggregate views populated by the list-groups endpoint. The single-group detail endpoint returns the metadata-only view and omits both fields.
Show child attributes
Show child attributes
Was this page helpful?
⌘I