PRODUCT
Follow

Related Entities

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 Ad Suite (SAS) 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

CustomFields

id

ID of entity. read-only parameter, auto-generated.

Integer

Read-only

relationsBag

Internal.

relationsBag Object

Internal

version

Internal.

Internal

Internal

createdBy

ID of the user that created the account.

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

Name of the account that was last to update the entity.

String

Read-only

lastUpdateOn

Date of last update (Date epoch).

Long

Read-only

name

Name of custom field.

String

Required

fieldType

accountId

ID of the campaign manager account.

Long

Required

accountName

description

typeSettings

typeSettings Object

fieldSettings

fieldSettings Object

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 Ad Suite (SAS) 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