Skip to main content
PATCH
Update company settings

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Headers

Idempotency-Key
string

Client-chosen key; replaying the same key + body returns the original response, a different body returns 409.

Body

application/json

Allowlist of settable profile/contact/socials/signing fields. Plan, billing, subscription, permissions, credits, and verification fields are never settable; unknown/forbidden keys are ignored. A patch with no allowlisted field is 400.

name
string
phone
string
address
string
category
string
companyStage
string
companyNiche
string
website
string
appstoreUrl
string
instagram
string
linkedin
string
tiktok
string
profileImageUrl
string
personalName
string
personalProfileImageUrl
string
signedName
string
ugcExperience
string
businessType
string

Response

The refreshed settings.

data
object
required

The token tenant's settings — an allowlisted projection of the company profile (only fields present on the doc are returned). Permissive.