PRODUCT
Follow

Related Entities

Endpoints Using the customFields Object

customFields 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

Read-only

CustomFields

id

Internal.

Internal

Internal

textFields

An object that contains all of the text fields defined on the entity that includes the custom field.

customTextField Object

Optional

numericFields

Internal.

Internal

Internal

decimalFields

Internal.

Internal

Internal

choiceListFields

An object that contains all of the choice list fields defined on the entity that includes the custom field.

customTextField Object

Optional

labelsFields

Internal.

Internal

Internal

Object JSON Example

customTextField Object

Related Entities

customTextField 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.

Parameter

Description

Type

Required

Notes

Number that represents the ID of the custom field defined on the account.

Number that represents the ID of the custom field defined on the account.

String

Read-only

type

Type of entity.

String

Read-only

CustomTextField

id

ID of the custom field defined on the account.

String

Read-only

name

Internal.

Internal

Internal

fieldType

Type of custom field that was defined on the account.

String

Required

accountId

Internal.

Internal

Internal

value

Value of the custom field as defined on the entity.

String

Optional

Object JSON Example

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

Comments

Powered by Zendesk