Mutations
updateThreadExternalId
Update the external ID of a thread. Pass externalId: null to clear it. Requires the thread:edit permission.
MUTATION
updateThreadExternalId(input: UpdateThreadExternalIdInput!): UpdateThreadExternalIdOutput!Arguments
input
required
Returns
thread
error
Mutation
mutation UpdateThreadExternalId($input: UpdateThreadExternalIdInput!) {
updateThreadExternalId(input: $input) {
thread {
id
ref
customer {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
title
description
previewText
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"threadId": "id"
}
}Response
{
"data": {
"updateThreadExternalId": {
"thread": {
"id": "id",
"ref": "string",
"customer": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
},
"title": "string",
"description": "string",
"previewText": "string"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}Was this page helpful?
⌘I
Mutation
mutation UpdateThreadExternalId($input: UpdateThreadExternalIdInput!) {
updateThreadExternalId(input: $input) {
thread {
id
ref
customer {
id
externalId
fullName
shortName
email {
__typename
}
avatarUrl
}
title
description
previewText
}
error {
message
type
code
fields {
field
message
type
}
}
}
}Variables
{
"input": {
"threadId": "id"
}
}Response
{
"data": {
"updateThreadExternalId": {
"thread": {
"id": "id",
"ref": "string",
"customer": {
"id": "id",
"externalId": "id",
"fullName": "string",
"shortName": "string",
"email": {
"__typename": "EmailAddress"
},
"avatarUrl": "string"
},
"title": "string",
"description": "string",
"previewText": "string"
},
"error": {
"message": "string",
"type": "VALIDATION",
"code": "string",
"fields": [
{
"field": "string",
"message": "string",
"type": "VALIDATION"
}
]
}
}
}
}
