PRODUCT
Follow

Endpoints Using the Brand Object

Object Definition

Note

Note: The Required column includes the following values:

  • Required: The field must be included in the POST call.

  • Read-only: The field is received in the GET call and required in the PUT call. It is not required in the POST call. You cannot edit this field.

  • Optional: If the field was received in the GET call, include it in the PUT call. This field is editable.

  • Internal: (For Sizmek internal use) If the field was received in the GET call, include it in the PUT call.

Name

Description

Type

Required

Notes

type

Type of entity.

String

Required

Value: Brand

id

ID of brand.

Long

Read-only

Auto-generated, read-only value.

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

String

Internal

createdBy

ID of the user that created the brand.

Long

Read-only

createdByName

Name of the user that created the entity.

String

Read-only

createdByAccount

ID of the account that created the entity.

Long

Read-only

createdByAccountName

Name of the account that created the entity.

String

Read-only

createdOn

Date of creation (date epoch).

Long

Read-only

lastUpdatedBy

ID of the user that was last to update the entity.

Long

Read-only

lastUpdatedByName

Name of the user that was last to update the entity

String

Read-only

lastUpdatedByAccount

ID of the account that was last to update the entity

Long

Read-only

lastUpdatedByAccountName

Parent advertiser analytics settings

String

Read-only

lastUpdateOn

Date of last update (date epoch).

Long

Read-only

name

Name of brand.

String

Required

advertiserId

ID of advertiser.

Integer

Required

vertical

Advertising niche for the brand.

String

Required

status

Brand status.

String

Read-only

adminSettings

Object container for joined setting of admin entities.

adminSettings Object

Optional with default values

customFields

Custom fields values on entity level, each field must have metadata definition on parent account.

customFields Object

Optional

accessLevel

Internal

Internal

Internal

Object JSON Example

Child Objects

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk