GEgetsales
whitelabels

Create whitelabel

Register a brand on a custom domain, born pending_domain: nothing serves until the reseller points the host's CNAME at the platform and activate_whitelabel proves it. Needs the White label entitlement on the workspace's share (403 whitelabel_not_enabled). domain is a bare lowercase FQDN, unique across the platform (409 domain_already_taken; 409 domain_held_by_deleted_whitelabel while a deleted brand still holds it, support releases it); the artwork is given as https URLs (the files are uploaded in the app); the palette is #rrggbb per slot; email_from_name and email_reply_to sign the clients' mail at once, email_from_address only after verify_whitelabel_email_domain proves its domain. The setup chain: create, hand over the CNAME, activate, poll get_whitelabel with include ssl_certificate until active.

Contract:

  • MCP tool create_whitelabel, registry package mcp.id/whitelabels, mount id.partner.
  • Operation create, response envelope create.
  • Flags: none.
post/api/whitelabels

Request

  • Base URL
    https://beta.getsales.io/id/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Request body

namestring required

The brand name, 1..255 chars.

domainstring required

The app and login host, bare lowercase FQDN (app.reseller.com): no scheme, no path.

logo_urlstring nullable

https URL of the horizontal logo; null clears it. The file itself is uploaded in the app.

icon_urlstring nullable

https URL of the square mark; null clears it.

login_image_urlstring nullable

https URL of the login artwork; null clears it.

email_from_namestring nullable

The From name on the clients' mail; null = the brand name.

email_reply_tostring email nullable

The Reply-To on the clients' mail; null = none.

email_from_addressstring email nullable

The brand's own sender address; refused on a host SendGrid cannot authenticate (422 email_domain_invalid), a platform domain (422 email_domain_reserved) or another team's (409 email_domain_already_taken). Proven by verify_whitelabel_email_domain.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.