Create Session

post

{protocol}://{server}{basePath}/accounts/{accountId}/sessions

Creates a new client session for the customer. A single customer can have multiple active sessions concurrently. For example, if a customer is logged-in through a mobile device and a computer, activities from both the devices can be represented using two separate sessions.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

request

channelProviderId

string

required

length between 3 and 256

The unique id that represents the channel provider

customerIdentifiers

object

required

Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.

displayName

string

length ≤ 70

The display name of the session

sessionParameters

object

Optional key/value session parameters for capturing properties of the user and the user's client device. Key is limited to 64 characters

providerCustomerId

string

length ≤ 256

The provider side identifier for the user

correlationId

string

length ≤ 256

The correlation id is used to uniquely identify the client request. This is an optional field but when specified can be used to correlate the callback event with the original API request. If the client does not pass any value for the correlation id in the request, a unique value will be generated automatically and sent back in the response.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses