Mutation
mutation CreateConversation($input: CreateConversationInput!) {
createConversation(input: $input) {
clientMutationId
conversation {
bookmarkedAt
id
lastChatAt
lastMessage {
actorType
artifact {
__typename
}
assets {
__typename
}
conversation {
__typename
}
createdAt
embeddedLink {
__typename
}
}
messages {
edges {
__typename
}
nodes {
__typename
}
pageInfo {
__typename
}
}
participants {
ambassadorLevel
ambassadorLevelId
avatarUrl
badges {
__typename
}
conversations {
__typename
}
customFieldResponses {
__typename
}
}
}
errors
message {
actorType
artifact {
createdAt
description
html
kind
status
summary
}
assets {
aspectRatio
assetStyle
contentType
fileSize
id
imageUrl
}
conversation {
bookmarkedAt
id
lastChatAt
lastMessage {
__typename
}
messages {
__typename
}
participants {
__typename
}
}
createdAt
embeddedLink {
actionText
description
faviconUrl
id
imageUrl
isVideo
}
}
outcome
}
}Variables
{
"input": {
"recipientIds": [
"id"
],
"text": "string"
}
}Response
{
"data": {
"createConversation": {
"clientMutationId": "string",
"conversation": {
"bookmarkedAt": "value",
"id": "id",
"lastChatAt": "value",
"lastMessage": {
"actorType": "COHOST",
"artifact": {
"__typename": "Artifact"
},
"assets": [
{
"__typename": "Asset"
}
],
"conversation": {
"__typename": "PrivateConversation"
},
"createdAt": "value",
"embeddedLink": {
"__typename": "EmbeddedLink"
}
},
"messages": {
"edges": [
{
"__typename": "PrivateMessageEdge"
}
],
"nodes": [
{
"__typename": "PrivateMessage"
}
],
"pageInfo": {
"__typename": "PageInfo"
}
},
"participants": [
{
"ambassadorLevel": "string",
"ambassadorLevelId": 1,
"avatarUrl": "string",
"badges": [
{
"__typename": "Badge"
}
],
"conversations": {
"__typename": "PublicConversationConnection"
},
"customFieldResponses": {
"__typename": "MemberCustomFieldResponseConnection"
}
}
]
},
"errors": [
"string"
],
"message": {
"actorType": "COHOST",
"artifact": {
"createdAt": "value",
"description": "string",
"html": "string",
"kind": "string",
"status": "string",
"summary": "string"
},
"assets": [
{
"aspectRatio": 1.5,
"assetStyle": "string",
"contentType": "string",
"fileSize": "string",
"id": "id",
"imageUrl": "string"
}
],
"conversation": {
"bookmarkedAt": "value",
"id": "id",
"lastChatAt": "value",
"lastMessage": {
"__typename": "PrivateMessage"
},
"messages": {
"__typename": "PrivateMessageConnection"
},
"participants": [
{
"__typename": "Member"
}
]
},
"createdAt": "value",
"embeddedLink": {
"actionText": "string",
"description": "string",
"faviconUrl": "string",
"id": "id",
"imageUrl": "string",
"isVideo": true
}
},
"outcome": "SENT"
}
}
}Mutations
createConversation
Start a direct-message conversation with the given recipients, or post to the existing one if it already exists
Required scope: write:chats
MUTATION
createConversation(input: CreateConversationInput!): CreateConversationPayloadArguments
input
required
Parameters for CreateConversation
Returns
clientMutationId
String
A unique identifier for the client performing the mutation.
conversation
errors
[String!]!
message
outcome
Mutation
mutation CreateConversation($input: CreateConversationInput!) {
createConversation(input: $input) {
clientMutationId
conversation {
bookmarkedAt
id
lastChatAt
lastMessage {
actorType
artifact {
__typename
}
assets {
__typename
}
conversation {
__typename
}
createdAt
embeddedLink {
__typename
}
}
messages {
edges {
__typename
}
nodes {
__typename
}
pageInfo {
__typename
}
}
participants {
ambassadorLevel
ambassadorLevelId
avatarUrl
badges {
__typename
}
conversations {
__typename
}
customFieldResponses {
__typename
}
}
}
errors
message {
actorType
artifact {
createdAt
description
html
kind
status
summary
}
assets {
aspectRatio
assetStyle
contentType
fileSize
id
imageUrl
}
conversation {
bookmarkedAt
id
lastChatAt
lastMessage {
__typename
}
messages {
__typename
}
participants {
__typename
}
}
createdAt
embeddedLink {
actionText
description
faviconUrl
id
imageUrl
isVideo
}
}
outcome
}
}Variables
{
"input": {
"recipientIds": [
"id"
],
"text": "string"
}
}Response
{
"data": {
"createConversation": {
"clientMutationId": "string",
"conversation": {
"bookmarkedAt": "value",
"id": "id",
"lastChatAt": "value",
"lastMessage": {
"actorType": "COHOST",
"artifact": {
"__typename": "Artifact"
},
"assets": [
{
"__typename": "Asset"
}
],
"conversation": {
"__typename": "PrivateConversation"
},
"createdAt": "value",
"embeddedLink": {
"__typename": "EmbeddedLink"
}
},
"messages": {
"edges": [
{
"__typename": "PrivateMessageEdge"
}
],
"nodes": [
{
"__typename": "PrivateMessage"
}
],
"pageInfo": {
"__typename": "PageInfo"
}
},
"participants": [
{
"ambassadorLevel": "string",
"ambassadorLevelId": 1,
"avatarUrl": "string",
"badges": [
{
"__typename": "Badge"
}
],
"conversations": {
"__typename": "PublicConversationConnection"
},
"customFieldResponses": {
"__typename": "MemberCustomFieldResponseConnection"
}
}
]
},
"errors": [
"string"
],
"message": {
"actorType": "COHOST",
"artifact": {
"createdAt": "value",
"description": "string",
"html": "string",
"kind": "string",
"status": "string",
"summary": "string"
},
"assets": [
{
"aspectRatio": 1.5,
"assetStyle": "string",
"contentType": "string",
"fileSize": "string",
"id": "id",
"imageUrl": "string"
}
],
"conversation": {
"bookmarkedAt": "value",
"id": "id",
"lastChatAt": "value",
"lastMessage": {
"__typename": "PrivateMessage"
},
"messages": {
"__typename": "PrivateMessageConnection"
},
"participants": [
{
"__typename": "Member"
}
]
},
"createdAt": "value",
"embeddedLink": {
"actionText": "string",
"description": "string",
"faviconUrl": "string",
"id": "id",
"imageUrl": "string",
"isVideo": true
}
},
"outcome": "SENT"
}
}
}