Skip to main content
PATCH
/
v1
/
subaccounts
/
{subaccount_id}
Update Subaccount
curl --request PATCH \
  --url https://api.rivermarkets.com/v1/subaccounts/{subaccount_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "subaccount_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "is_active": true,
  "inserted_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for programmatic access. Generate one at app.rivermarkets.com under Settings → API Keys.

Path Parameters

​
subaccount_id
string
required

Body

application/json

Schema for updating a subaccount.

​
name
string | null
Maximum string length: 100
​
description
string | null
Maximum string length: 500

Response

Successful Response

Schema for subaccount response.

​
subaccount_id
string<uuid>
required
​
name
string
required
​
is_active
boolean
required
​
inserted_at
string<date-time>
required
​
description
string | null