Reseller company data and customer-facing brand configuration use different API resources. Read the current object before editing it, and use the returned version where available so a concurrent administrator's changes are not silently overwritten.
IN THIS ARTICLE
01 Choose the resource
| Method | Resource | Scope | Idempotency-Key |
|---|---|---|---|
GET |
/v2/profile |
profile:read |
Not required by this route |
PATCH |
/v2/profile |
profile:write |
Required |
GET |
/v2/profile/brand |
brand:read |
Not required by this route |
PATCH |
/v2/profile/brand |
brand:write |
Required |
The profile PATCH currently accepts company_name. It does not change the login email, password, tier, wallet or reseller approval. Brand PATCH accepts its documented brand fields, including name, logo reference, colour and support/documentation addresses.
02 Apply a reviewed update
- GET the current profile or brand. A brand read may return null before any brand is saved.
- Prepare the intended values. For brand edits, explicitly retain the intended
brand_name,primary_colorandstatus, because this helper supplies defaults when those fields are omitted. - When the object has a row version, pass the expected numeric version in
If-Match. Use the current API contract's supported version format. - Submit the PATCH with an idempotency key.
- Read the saved object again and inspect the relevant customer-facing page or connector publication separately.
Why did an omitted brand field change?
This endpoint's helper applies defaults to selected fields even for PATCH. A generic client that assumes every omitted property remains untouched can therefore produce an unintended brand name, colour or draft state. Build the complete intended values for those fields from the fresh read.
Does custom_domain create DNS and HTTPS?
No. Saving a brand-domain setting records configuration. DNS, hostname routing and certificate readiness require their own supported setup and verification. Do not publish a new brand address until it is reachable through the intended service.
If a version conflict occurs, reload and compare both edits. Do not remove If-Match merely to force the old payload through. Similarly, use an approved logo asset reference rather than inventing a server filesystem path in the API request.