Creates a conversation

post

https://public-api.production.liveswitch.com/v1/conversations

Required scope: conversations.write

Body Params

contactId

uuid | null

The ID of the Contact record this Conversation will be associated with; if set and valid, the phone number will be ignored. If set and invalid, throws an error. If the contact exists, it will NOT be updated.

phone

string | null

The Phone of the Contact record this Conversation will be associated with; if set, the phone number will be looked up and if a Contact exists with that number, that Contact will be utilized. If the phone number does NOT exist, a new contact will be created using the specified number. If the contact exists, it will NOT be updated.

email

string | null

The Email of the Contact record this Conversation will be associated with if it is created.

firstName

string | null

The FirstName of the Contact record this Conversation will be associated with if it is created.

lastName

string | null

The LastName of the Contact record this Conversation will be associated with if it is created.

message

string | null

The contents of the text message the user will receive.

name

string | null

Optional name/title for the conversation. For StartRecording, this becomes the session name. For TakePhotos, this becomes the photo session name.

type

string

enum

required

Represents the type of Conversation

Allowed:

tags

array of strings | null

Optional. Array of tag names to assign to the project. Tags will be auto-created if they don't exist.

tags

autoStartRecording

boolean

This only applies to LiveConversation

sendSmsNotification

boolean

When set to false, the user is not sent a text message invite to the Conversation.

projectId

string | null

Optional. The id of a project to associate the conversation with. If specified, will link this session into the specified project. If this value is provided then ProjectExternalId will be ignored.

projectExternalId

string | null

Optional. The external id of a project to associate this conversation with. If specified, will link this session into the specified project. See LiveSwitch.Integration.Api.Models.v1.Conversation.ConversationCreateRequestDto.ProjectAutoCreate for more.

projectAutoCreate

boolean

Optional, default false. If this value is true, and no project with the specified ProjectExternalId exists, a project will be created using the ProjectExternalId and ProjectName. If this value is true, ProjectExternalId is required. If this value is false, and the ProjectExternalId is specified but does not exist, the request will fail and no data will be modified.

projectName

string | null

Optional, default empty. Only used if ProjectAutoCreate is true, and no project with a matching ProjectExternalId was found. If not specified, will auto-generate a name using the pattern "Project [project external id]". Note that project names must be unique.

attributes

array of objects | null

Optional attributes to set on the conversation. Use either attributeId or attributeGroupName+attributeName.

attributes

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json