GEgetsales
whitelabels

Update whitelabel

Rebrand: name, the artwork URLs, the palette and the email chrome, effective on the next app load and the next email. domain changes only while pending_domain (422 on a live brand: disable and create anew). A new email_from_address on another domain drops the old proof: verify it again. At least one field, else 422 nothing_to_update.

Contract:

  • MCP tool update_whitelabel, registry package mcp.id/whitelabels, mount id.partner.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/whitelabels/{sid}

Request

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

Path parameters

sidstring required

Whitelabel (brand) sid (id_wl_...).

Request body

namestring

New brand name, 1..255 chars.

domainstring

New host, only while the brand is pending_domain.

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

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.

Changes

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