Sign in
Tenants

Update current tenant

Update tenant profile fields such as company name, webhook URL, or custom settings.

patch/api/tenants/me

Request body

namestring
emailstring
webhookUrlstring
settingsobject

Custom tenant settings (merged with existing)

Example request

{
  "name": "Updated Company Name",
  "email": "billing@company.com",
  "webhookUrl": "https://example.com/webhooks"
}

Response

Tenant profile updated

idstring required
namestring required
slugstring required
emailstring required
apiKeystring required
webhookUrlstring
webhookSecretstring
isActiveboolean required
settingsobject
lastLoginAtstring
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "name": "Acme Corp",
  "slug": "acme-corp",
  "email": "john@company.com",
  "apiKey": "sk_live_abc123...",
  "webhookUrl": "https://example.com/webhooks",
  "webhookSecret": "whsec_abc123...",
  "isActive": true
}

Changes

Changed in 1 of the 2 revisions of this API.2

  • 0e449a4e0dc82See the full diff
    • ○

      added the new optional request property email

      new-optional-request-property

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added