REST Resource: brands

  • A brand is a business, organization, or group represented by an agent.

  • Brands are represented in JSON with name and displayName fields.

  • The name field is a unique identifier output only field defined by the platform.

  • The displayName field is a required string with a maximum of 100 characters.

  • You can create, delete, get, list, and patch brands using available methods.

Resource: Brand

A brand (business, organization, or group) that is represented by an agent.

JSON representation
{
  "name": string,
  "displayName": string
}
Fields
name

string

Output only. The unique identifier of the brand.

Defined by the platform.

displayName

string

Required. The display name of the brand. Maximum 100 characters.

Methods

create

Creates a new brand.

delete

Deletes a brand.

get

Gets information about a brand.

list

Lists all the brands accessible to the user making the request.

patch

Updates information about a brand.