Skip to main content
PATCH
cURL

Authorizations

Authorization
string
header
required

An access token, bound to one account.

Path Parameters

id
string
required
inboxId
string
required

Body

application/json
scope
object
rollout
object
sendReplies
any
Available options:
1,
1,
true,
true,
on,
0,
0,
false,
false
drafts
enum<string>[]
Available options:
note,
native_draft,
composer_insert,
macro_insert,
panel
handoffDrafts
any
Available options:
1,
1,
true,
true,
on,
0,
0,
false,
false
alwaysDraft
any
Available options:
1,
1,
true,
true,
on,
0,
0,
false,
false
replyIdentity
object
afterReply
enum<string>
Available options:
inherit,
unchanged,
open,
waiting_on_customer,
closed
waitingSnoozeHours
integer
Required range: 1 <= x <= 8760
quietPeriodSeconds
integer
Required range: 0 <= x <= 600
topicsWriteBack
object
outcomeWriteBack
object
meta
object
mode
enum<string>
Available options:
assists,
owns
vendorAi
enum<string>
Available options:
alongside,
after_handover
handBack
object
reset
enum<string>[]
Available options:
scope.media,
scope.tags.include,
scope.tags.exclude,
rollout.mode,
rollout.testSenders,
rollout.percentage,
sendReplies,
drafts,
handoffDrafts,
alwaysDraft,
replyIdentity.authorExternalId,
replyIdentity.fromAddress,
replyIdentity.senderName,
afterReply,
waitingSnoozeHours,
quietPeriodSeconds,
topicsWriteBack.enabled,
topicsWriteBack.prefix,
topicsWriteBack.field,
outcomeWriteBack.tags,
outcomeWriteBack.field,
meta.humanAgentTag,
mode,
vendorAi,
handBack.to,
handBack.teammateExternalId,
handBack.teamExternalId,
handBack.tag,
handBack.mentions

Response

OK

data
object
required