Cowdidocs
API ReferenceBranding

Delete an organization's brand

DELETE
/v1/branding/{organizationId}

Removes the brand for organizationId. Requires a WorkOS bearer token whose cowdi_org_id matches organizationId, plus the org:branding:write permission (override with BRANDING_WRITE_PERMISSION). Returns 404 when the organization has no brand.

Authorization

oauth2
AuthorizationBearer <token>

Create a client with POST /v1/oauth/clients, then exchange its credentials for an access token. AUTHORIZATION_CODE clients act on behalf of a signed-in user and always use PKCE; CLIENT_CREDENTIALS clients act as themselves. A client may only be granted scopes its creator already holds — read the grantable list from GET /v1/oauth/clients/scopes.

In: header

Path Parameters

organizationId*string

Backend organization id / tenant slug.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v1/branding/dawa"
Empty
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}
{  "code": "INVALID_PARAMS",  "description": "user_id must be a UUID",  "identifier": "string",  "invalid_params": [    {      "path": "user_id",      "reason": "must be a UUID",      "sub_code": "string"    }  ]}

Create or replace an organization's brand PUT

Replaces the brand for `organizationId` in full, creating it on the first call. `primary_color` is required; every omitted optional field is cleared, not left unchanged. Requires a WorkOS bearer token whose `cowdi_org_id` matches `organizationId`, plus the `org:branding:write` permission (override with BRANDING_WRITE_PERMISSION). Returns 403 when either check fails.

Get the caller's user record GET

Returns the caller's user record. The response includes the caller's profile email and phone contacts, and suspension details when `status` is `SUSPENDED`. A user token calls this on behalf of the signed-in user.