Type: array

An array of contact objects with 1 or more items.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root contact

contact

Type: object

contact object representation to be sent by Opco during AX initialization phase

root contact anyOf item 0
Type: object

The following properties are required:

  • email
root contact anyOf item 1
Type: object

The following properties are required:

  • mobilePhoneNumber
root contact anyOf item 2
Type: object

The following properties are required:

  • landlinePhoneNumber
root contact anyOf item 3
Type: object

The following properties are required:

  • teamEmail

root contact eventHeader
Type: object Default: {"source": "OPCO", "version": "v1"}

This object is used to describe some technical meta information related to the event

root contact eventHeader source
Type: enum (of string)

The application source of this event

Must be one of:

  • "SPARK"
  • "SPARK_AX"
  • "OPCO"

root contact eventHeader version
Type: enum (of string)

The version of the json format event

Must be one of:

  • "v1"

root contact scope
Type: array of enum (of string) Default: ["CONTACT"]

All items must be unique

No Additional Items

Each item of this array must be:

root contact scope scope items
Type: enum (of string)

Scope is used to decide what to be updated in the case of a matched online contact ( using email field ). CONSENT to enable to update doNotBulkSMS, doNotBulkEmail. CONTACT to enable to update opcoContactId

Must be one of:

  • "CONTACT"
  • "CONSENT"

root contact opcoContactId
Type: string

OpCo's unique legacy identifier of an existing contact to Spark. can be either CRM legacy Id or ERP Id
Example:

"1234567"

root contact firstName
Type: string

Type the contact's first name to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns.
Example:

"Jane"

root contact lastName
Type: string

Type the contact's last name to make sure the contact is addressed correctly in sales calls, email, and marketing campaigns.
Example:

"Doe"

root contact email
Type: string

Type the primary email address for the contact.
Example:

"jane.doe@standelec.com"

root contact mobilePhoneNumber
Type: string

Type the mobile phone number for the contact conforming to the ITU-T E.164 international public telecommunication numbering plan.
Example:

"+336102030405"

root contact landlinePhoneNumber
Type: string

Type the landline phone number for the contact conforming to the ITU-T E.164 international public telecommunication numbering plan.
Example:

"+330102030405"

root contact teamEmail
Type: string

Type the email address for the team of the contact.
Example:

"buyers@standelec.com"

root contact defaultLanguage
Type: string

Language of the contact

root contact jobRole
Type: string

Specify the Job Role for this Contact. Must be equal to a code of one of the Reference Items published in the Account references with reference type = JOB_TITLE .Not mandatory for init.

root contact primaryAccountId
Type: string

Primary account id for the contact

root contact attachedAccountIds
Type: array of string

List of attached accounts / prospects to the contact

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root contact attachedAccountIds attachedAccountIds items
Type: string

List of attached accounts / prospects to the contact

root contact doNotBulkEmail
Default: [true]

Select whether the contact accepts bulk email sent through marketing campaigns or quick campaigns. If Do Not Allow is selected, the contact can be added to marketing lists, but will be excluded from the email.

root contact doNotBulkEmail oneOf item 0
Type: const

Do Not Allow

Specific value: true
root contact doNotBulkEmail oneOf item 1
Type: const

Allow

Specific value: false

Example:

true

root contact doNotBulkSms
Default: [true]

Select whether the contact accepts bulk sms sent through marketing campaigns or quick campaigns. If Do Not Allow is selected, the contact can be added to marketing lists, but will be excluded from the sms.

root contact doNotBulkSms oneOf item 0
Type: const

Do Not Allow

Specific value: true
root contact doNotBulkSms oneOf item 1
Type: const

Allow

Specific value: false

Example:

true