Contacts event ingest

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:write

Graphql

Mutation.contactsEventIngest

Sdk

contacts.event.ingest

Cli

contacts event ingest

Request bodyapplication/json, required

• atstring (date-time)
• kindstringrequired
  At most 60 characters. Pattern: ^[a-z_]+(.[a-z_]+){0,3}$.
• channelstringrequired
  One of: email, sms, whatsapp, phone, chat, shop, booking, payment, form, note, task, deal, system.
• directionstring
  One of: in, out, internal. Default: internal.
• summarystring
  Default: . At most 500 characters.
• refKindstring or null
• refIdstring or null
• dataobject
• activityboolean
• identityobjectrequired
  • kindstringrequired
    At most 40 characters.
  • valuestringrequired
    At most 320 characters.
  • namestring
    At most 200 characters.
  • countrystring
    At most 2 characters.
• sourcestring
  At most 60 characters.
• ordersobject
  • countintegerrequired
  • totalMinorintegerrequired
• lifecyclestring
  One of: subscriber, lead, customer, partner, other.

Responses

• 201application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring