Skip to main content
A party’s branding is its brand color and, for a business, its profile photo. Its id is the party ID (pty_*). The embedded checkout uses the brand color.

Example

GET /parties/{partyId}/branding
The object is everything inside data. The field names below are relative to it: attributes.brandColor is data.attributes.brandColor in the response.

Fields

string
required
Resource type. Always partyBranding.
string
required
ID of the party the branding belongs to (pty_*).
object
required
The branding’s details.

Events

This resource sends no webhook events.

Other objects

These endpoints in the group don’t return this object:
  • Create branding photo upload (POST /parties/{partyId}/branding/photo-uploads) returns a partyAvatarUpload object.

Errors

See the error codes these endpoints return.

Sandbox simulations

None.