White label

Enterprise white label (N-09): brand name, accent colour, "powered by", email sender, workspace domains verified by DNS and the branded Android app’s build manifest.

GET/v1/white-label

White label

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.view.

Response · 200

datarequired: WhiteLabel
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/white-label' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "entitled": true,
    "brand_name": "string",
    "brand_color": "string",
    "accent_color": "string",
    "hide_powered_by": true,
    "powered_by": true,
    "email_from_name": "string",
    "email_identity_id": "cmusrceel0000q7kaafxqi1om",
    "android_app_name": "string",
    "android_package_id": "string",
    "favicon_url": "string",
    "app_icon_url": "string",
    "warnings": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/white-label

Change the white label

Fields left out keep their value; null clears one. Colours are checked for contrast (WCAG 2.2).

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.white_label.

Request body

brand_name: string or null
accent_color: string or null
hide_powered_by: boolean
email_from_name: string or null
email_identity_id: Id or null
Opaque record id.
android_app_name: string or null
android_package_id: string or null

Response · 200

datarequired: WhiteLabel
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/white-label' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"brand_name":"string","accent_color":"string","hide_powered_by":true,"email_from_name":"string","email_identity_id":"cmusrceel0000q7kaafxqi1om","android_app_name":"string","android_package_id":"string"}'

Response example

{
  "data": {
    "entitled": true,
    "brand_name": "string",
    "brand_color": "string",
    "accent_color": "string",
    "hide_powered_by": true,
    "powered_by": true,
    "email_from_name": "string",
    "email_identity_id": "cmusrceel0000q7kaafxqi1om",
    "android_app_name": "string",
    "android_package_id": "string",
    "favicon_url": "string",
    "app_icon_url": "string",
    "warnings": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/white-label/android-manifest

Branded Android app manifest

The build configuration of the company’s branded app, with what a release still needs.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.view.

Response · 200

datarequired: object
data.manifestrequired: object
data.manifest.schemarequired: 1
data.manifest.company_idrequired: Id
Opaque record id.
data.manifest.app_namerequired: string
data.manifest.package_idrequired: string
data.manifest.colorsrequired: object
data.manifest.iconsrequired: object
data.manifest.urlsrequired: object
data.manifest.powered_byrequired: boolean
data.manifest.generated_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.missingrequired: array of string
data.readyrequired: boolean
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/white-label/android-manifest' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "manifest": {
      "schema": 1,
      "company_id": "cmusrceel0000q7kaafxqi1om",
      "app_name": "string",
      "package_id": "string",
      "colors": {
        "brand": "string",
        "accent": "string",
        "background_light": "string",
        "background_dark": "string"
      },
      "icons": {
        "app_icon": "string",
        "logo": "string"
      },
      "urls": {
        "workspace": "string",
        "api": "string"
      },
      "powered_by": true,
      "generated_at": "2026-10-06T05:30:00.000Z"
    },
    "missing": [
      "string"
    ],
    "ready": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/white-label/domains

Workspace domains

The company’s own sign-in addresses with the DNS records to add.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.view.

Response · 200

datarequired: object
data.domainsrequired: array of WorkspaceDomain
data.limitrequired: integer
data.cname_targetrequired: string or null
data.entitledrequired: boolean
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/white-label/domains' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "domains": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "hostname": "string",
        "status": "pending",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "checked_at": "2026-10-06T05:30:00.000Z",
        "records": [
          {
            "type": "CNAME",
            "name": "string",
            "host": "string",
            "value": "string"
          }
        ],
        "last_error": "string",
        "url": "string",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "limit": 0,
    "cname_target": "string",
    "entitled": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/white-label/domains

Add a workspace domain

A sub-domain the company owns (crm.acme.in). It goes live once the TXT and CNAME records are found. Needs a recent two-factor check.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.white_label.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

hostnamerequired: string

Response · 201

datarequired: WorkspaceDomain
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/white-label/domains' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"hostname":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string",
    "status": "pending",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "host": "string",
        "value": "string"
      }
    ],
    "last_error": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/white-label/domains/{id}

Remove a workspace domain

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.white_label.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.hostnamerequired: string
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/white-label/domains/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/white-label/domains/{id}/check

Check a workspace domain now

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.white_label.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: WorkspaceDomain
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/white-label/domains/{id}/check' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string",
    "status": "pending",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "checked_at": "2026-10-06T05:30:00.000Z",
    "records": [
      {
        "type": "CNAME",
        "name": "string",
        "host": "string",
        "value": "string"
      }
    ],
    "last_error": "string",
    "url": "string",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": { "entitled": true, "brand_name": "string", "brand_color": "string", "accent_color": "string", "hide_powered_by": true, "powered_by": true, "email_from_name": "string", "email_identity_id": "cmusrceel0000q7kaafxqi1om", "android_app_name": "string", "android_package_id": "string", "favicon_url": "string", "app_icon_url": "string", "warnings": [ "string" ] }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/white-label' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"brand_name":"string","accent_color":"string","hide_powered_by":true,"email_from_name":"string","email_identity_id":"cmusrceel0000q7kaafxqi1om","android_app_name":"string","android_package_id":"string"}'

{ "data": { "manifest": { "schema": 1, "company_id": "cmusrceel0000q7kaafxqi1om", "app_name": "string", "package_id": "string", "colors": { "brand": "string", "accent": "string", "background_light": "string", "background_dark": "string" }, "icons": { "app_icon": "string", "logo": "string" }, "urls": { "workspace": "string", "api": "string" }, "powered_by": true, "generated_at": "2026-10-06T05:30:00.000Z" }, "missing": [ "string" ], "ready": true }, "meta": {} }

{ "data": { "domains": [ { "id": "cmusrceel0000q7kaafxqi1om", "hostname": "string", "status": "pending", "verified_at": "2026-10-06T05:30:00.000Z", "checked_at": "2026-10-06T05:30:00.000Z", "records": [ { "type": "CNAME", "name": "string", "host": "string", "value": "string" } ], "last_error": "string", "url": "string", "created_at": "2026-10-06T05:30:00.000Z" } ], "limit": 0, "cname_target": "string", "entitled": true }, "meta": {} }

curl -X POST 'https://api.propzolo.com/v1/white-label/domains' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"hostname":"string"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "hostname": "string", "status": "pending", "verified_at": "2026-10-06T05:30:00.000Z", "checked_at": "2026-10-06T05:30:00.000Z", "records": [ { "type": "CNAME", "name": "string", "host": "string", "value": "string" } ], "last_error": "string", "url": "string", "created_at": "2026-10-06T05:30:00.000Z" }, "meta": {} }

DELETE/v1/white-label/domains/{id}

Remove a workspace domain

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.white_label.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.hostnamerequired: string
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/white-label/domains/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "hostname": "string"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.