_ExcerptAPIIPMMappingObjectCreateUpdate

mappingName

Type

Required

Example

StringTrueMap sales webchat

A name for the mapping. The name is unique in the account.

mappingDescription

Type

Required

Example

StringTrueLinks sales webchat to sales interaction plan

A description of the mapping, describing its purpose.

interactionPlanId

Type

Required

Example

StringOptional4556d0fc-335d-4f19-b764-b5aa3bf7ba4a

The ID of the interaction plan linked to this mapping.

dataSources

Type

Required

Example

ObjectOptional
{
  "name""mapping version",
  "value""3"
}

Data sources that will be created for interactions created using this mapping.

  • name. The value used to reference the data source.
  • value. The initial value of the data source.

toAddresses

Type

Required

Example

ArrayOptional

[

  "+441234567890",

  "+449876543210"

]

An array of one or more addresses that represent contact information used to identify and reach the contact center. They could be in the form of a phone number, email address, social media handle, or other, depending on the channel of communication.