Skip to main content

ContactStoreMarketingRecord

Defines a marketing record associated with a contact store scoped contact.

type ContactStoreMarketingRecord {
  contact: ContactStoreContact!
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]!
  group: ContactStoreMarketingGroup!
  id: ID!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  name: String!
  subTag: ContactStoreMarketingSubTag
  tag: ContactStoreMarketingTag!
  type: MarketingTagType!
  value: JSON
}

Fields​

ContactStoreMarketingRecord.contact ● ContactStoreContact! non-null object​

The contact who the marketing record belongs to.

ContactStoreMarketingRecord.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

ContactStoreMarketingRecord.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

ContactStoreMarketingRecord.customFields ● [CustomField!]! non-null object​

A list of custom field values associated with this marketing record.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
ContactStoreMarketingRecord.customFields.input ● CustomFieldSearchFilterInput! non-null input​
ContactStoreMarketingRecord.customFields.limit ● PaginationLimit! non-null scalar​
ContactStoreMarketingRecord.customFields.offset ● NonNegativeInt! non-null scalar​

ContactStoreMarketingRecord.group ● ContactStoreMarketingGroup! non-null object​

The marketing group the record is a part of.

ContactStoreMarketingRecord.id ● ID! non-null scalar​

The unique identifier for the marketing record.

ContactStoreMarketingRecord.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

ContactStoreMarketingRecord.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

ContactStoreMarketingRecord.name ● String! non-null scalar​

UTF-8 string value that represents the name of the marketing record.

ContactStoreMarketingRecord.subTag ● ContactStoreMarketingSubTag object​

The marketing sub-tag that defines this record. Optional.

Where type is SUB_TAG, it will contain the value that is assigned to the record. For other marketing tag types, it will be null.

ContactStoreMarketingRecord.tag ● ContactStoreMarketingTag! non-null object​

The marketing tag that defines this record.

ContactStoreMarketingRecord.type ● MarketingTagType! non-null enum​

Represents the type of the marketing tag.

ContactStoreMarketingRecord.value ● JSON scalar​

The marketing record value returned as a JSON value. Optional.

For marketing records of type TAG_ONLY this will be null.

Member Of​

ContactStore object ● ContactStoreContact object ● ContactStoreMarketingTag object ● CreateContactStoreMarketingRecordPayload object ● UpdateContactStoreMarketingRecordPayload object