Update an organization's slug, logo and branding overrides
PATCH /v1/organizations/{org}/profile: Update an organization's slug, logo and branding overrides.
PATCH /
slug is unique per environment (lower-case letters, digits and hyphens, 1–63 characters; organization_slug_taken when used). logo_url must be a URL returned by POST /v1/branding/logo for this environment. logo_url and branding overrides need Pro or above (plan_limit_reached). An explicit null clears a field; absent fields are kept. Unset fields fall back to the environment branding.
- Scope
organizations:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Path parameters
Section titled “Path parameters”orgstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”slugstring or nulllogo_urlstring or nullprimary_colorstring or null
Responses
Section titled “Responses”- 200 OK OrganizationProfile
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X PATCH \ "https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/profile" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "slug": "acme", "logo_url": "https://app.acme.com/callback", "primary_color": "example_primary_color"}'const response = await fetch("https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/profile", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "slug": "acme", "logo_url": "https://app.acme.com/callback", "primary_color": "example_primary_color" }),});const data = await response.json();import osimport requests
response = requests.patch( "https://api.ohauthcat.com/v1/organizations/org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/profile", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "slug": "acme", "logo_url": "https://app.acme.com/callback", "primary_color": "example_primary_color", },)data = response.json(){ "object": "organization_profile", "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", "slug": "acme", "logo_url": "https://app.acme.com/callback", "primary_color": "example_primary_color", "effective_logo_url": "https://app.acme.com/callback"}