Skip to main content
PATCH
/
api
/
subdomains
/
{id}
Update a subdomain (tenant)
curl --request PATCH \
  --url https://clarus-api.com/api/subdomains/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "subdomains",
    "attributes": {
      "company_name": "Acme Logistics (UK) Ltd",
      "import_timezone": "Europe/London",
      "is_live": true
    }
  }
}
'
{
  "data": {
    "id": "57",
    "type": "subdomains",
    "attributes": {
      "subdomain": "acme-logistics",
      "company_name": "Acme Logistics (UK) Ltd",
      "is_active": true,
      "is_live": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the subdomain to update

Body

application/json
​
data
object
required

Response

Updated successfully

​
data
object