Update a conversation

PATCH

/v1/amb/conversations/{conversation_id}

const result = await bird.amb.conversations.update(
  "acv_01krdgeqcxet5s7t44vh8rt9mg",
  { assigned_to: null, labels: [], inbox_status: "resolved" },
);
console.log(result);

result = client.amb.conversations.update('acv_01krdgeqcxet5s7t44vh8rt9mg', assigned_to=None, labels=[], inbox_status="resolved")
print(result)

result, err := client.Amb.Conversations.Update(ctx, "acv_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbConversationsUpdateParams{AssignedTo: bird.Null[string](), Labels: []string{}, InboxStatus: bird.Ptr(bird.ConversationInboxStatus("resolved"))})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->conversations->update('acv_01krdgeqcxet5s7t44vh8rt9mg', (new Model\AMBConversationUpdate())->setAssignedTo(null)->setLabels([])->setInboxStatus('resolved'));

bird amb conversations update <conversation-id> --body-file - <<'JSON'
{
  "assigned_to": "me",
  "inbox_status": "open",
  "labels": [
    "billing",
    "vip"
  ],
  "queue": "billing",
  "routing_change": {
    "action": "dismiss",
    "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
  }
}
JSON

curl -X PATCH "https://us1.platform.bird.com/v1/amb/conversations/{conversation_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "assigned_to": "me",
    "inbox_status": "open",
    "labels": [
      "billing",
      "vip"
    ],
    "queue": "billing",
    "routing_change": {
      "action": "dismiss",
      "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
    }
  }'

Réponse200

{
  "inbox_status": "open",
  "routing": {
    "entry_point": "support",
    "queue": "support"
  },
  "routing_change": {
    "entry_point": "billing",
    "queue": "billing",
    "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "last_message": {
    "id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
    "direction": "outbound"
  },
  "id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "open",
  "origin": "entry_point",
  "device_capabilities": [
    "QUICK",
    "LIST",
    "TIME"
  ],
  "supported_content_kinds": [
    "text"
  ],
  "locale": "en-US",
  "assigned_to": "usr_01krdgeqcxet5s7t44vh8rt9mg",
  "labels": [
    "billing",
    "vip"
  ],
  "closed_reason": "user_close"
}

Updates assignment, labels, inbox status, queue, or shared workspace read state, or settles a pending routing_change. A routing decision names the change's message_id and fails with 409 when a newer change replaced it. Moving the queue does not run routing rules. Resolving inbox work preserves the conversation and its Apple channel state. A new inbound message reopens the inbox work. To acknowledge messages, pass read with a date-time cutoff for their created_at. Only inbound messages already received at or before that cutoff are marked read. Messages sharing the timestamp are included together; later arrivals remain unread. Use assigned_to: me to assign yourself, a workspace member ID to assign a teammate, or null to unassign. An API key cannot use me.

Paramètres

conversation_idstring

Conversation identifier. Starts with acv_.

Corps de la requête

assigned_to

nullable string

User to assign this conversation to. Pass a workspace member's user ID, me for the signed-in user, or null to unassign it. An API key cannot use me and receives a 422 response.

inbox_status

string

Whether the conversation needs attention in the workspace inbox. Set it to resolved when the work is finished. A new inbound message reopens the same conversation. Changing inbox status preserves message history and does not change the channel's permission to send messages or mark messages read.

Possible values: open, resolved

labels

array of string

Labels chosen by your workspace. On update, this replaces the full set; pass an empty array to clear every label. Labels do not change read state or inbox status.

Each label must contain 1 to 64 characters, with no commas, control characters, or leading or trailing whitespace. Duplicate labels are rejected. The names all, archived, assigned, closed, deleted, draft, drafts, flagged, important, inbox, junk, muted, none, open, pinned, read, snoozed, spam, starred, trash, and unread are reserved in every casing.

read

string

Mark received inbound messages with created_at at or before this timestamp as read in the shared workspace inbox. Messages sharing the timestamp are included together. Later arrivals remain unread until another read update. This does not send a read receipt to the customer or change inbox status. Omit to leave read state unchanged.

queue

nullable string

Queue to move the conversation to, or null to leave it unrouted. Routing rules do not run, and the conversation keeps its group and intent. Moving the queue clears any pending routing_change, and cannot be combined with an apply decision.

routing_change

object

Settles the conversation's pending routing_change. message_id names the change you reviewed: the request fails with 409 when the pending change has a different message ID, because a newer customer message replaced it or a teammate already settled it. Either action clears routing_change.

Afficher les paramètres enfants

routing_change.action

string

obligatoire

apply adopts the pending change's group, intent, entry point and queue. dismiss discards it and leaves group, intent and entry point unchanged.

Possible values: apply, dismiss

routing_change.message_id

string

obligatoire

Contenu de la réponse

inbox_status

string

obligatoire

Possible values: open, resolved

recipient

object

obligatoire

The customer on the other side of this Apple Messages for Business conversation.

Afficher les attributs enfants

routing

object

obligatoire

Routing context the conversation is filed under. Routing rules set it when the conversation opens or reopens, or when the customer writes after it was resolved. A teammate can move the queue or apply a pending routing_change.

Afficher les attributs enfants

routing_change

nullable object

obligatoire

Routing from a later customer message that differs from routing, waiting for a teammate to apply or dismiss it. Null when there is none. Only recorded while the inbox status is open; resolving the conversation or moving its queue clears it.

Afficher les attributs enfants

last_message

nullable object

obligatoire

Most recent message, or null when its identity has not been recorded.

Afficher les attributs enfants

id

string

obligatoire

Conversation ID.

business_account_id

string

obligatoire

Business this conversation belongs to.

status

string

obligatoire

Apple's native conversation state, which determines whether replies can be sent. A customer close or an Apple 410 response closes it; a newer inbound message reopens it. This API has no native close operation. Use inbox_status to resolve workspace inbox work independently.

Possible values: open, closed

origin

string

obligatoire

How the conversation started. entry_point means the customer opened it from one of your configured Apple Messages for Business entry points. invitation means the customer accepted an invitation and sent a message. This is set once when the conversation is created and never changes.

Possible values: entry_point, invitation

device_capabilities

array of string

obligatoire

The capability tokens the customer's device advertised on its most recent message, replaced by each inbound rather than accumulated, so this describes the device in use now. An empty list means the device's capabilities are unknown. Implemented message types may still be sent, but device rendering support has not been confirmed. Authentication requires an explicitly advertised AUTH2 capability.

supported_content_kinds

array of string

obligatoire

Implemented baseline types plus interactive types confirmed by device_capabilities. An empty capability list yields text, attachments and rich links; it does not establish support for other types. Unadvertised quick replies, list pickers, time pickers and forms are refused when capabilities are known. Custom apps and opaque interactive references are not included because their device support cannot be inferred from these tokens. Unsupported roadmap types cannot be sent.

locale

string

obligatoire

The customer's locale from the most recent inbound message, or your business's default locale before any inbound arrives. Preserved in Apple's locale format, for example en_US@rg=nlzzzz.

unread_count

integer

obligatoire

Number of inbound messages the workspace has not acknowledged. Shared across the workspace. Pass read with a date-time to acknowledge received inbound messages through that timestamp. Sending a reply does not change this count.

assigned_to

nullable string

obligatoire

The user this conversation is assigned to, or null when unassigned. Assignment is not rechecked against workspace membership on read, so it can still name a user whose access was removed.

labels

array of string

obligatoire

Workspace labels on this conversation. Labels do not change read state or inbox status.

closed_at

nullable string

obligatoire

When the native Apple conversation was closed. Null while its native status is open; independent of inbox status.

closed_reason

nullable string

obligatoire

Why the native Apple conversation was closed. Null while its native status is open; independent of inbox status.

created_at

string

obligatoire

When this conversation was created.

updated_at

string

obligatoire

When this conversation last changed.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation

const result = await bird.amb.conversations.update(
  "acv_01krdgeqcxet5s7t44vh8rt9mg",
  { assigned_to: null, labels: [], inbox_status: "resolved" },
);
console.log(result);

result = client.amb.conversations.update('acv_01krdgeqcxet5s7t44vh8rt9mg', assigned_to=None, labels=[], inbox_status="resolved")
print(result)

result, err := client.Amb.Conversations.Update(ctx, "acv_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbConversationsUpdateParams{AssignedTo: bird.Null[string](), Labels: []string{}, InboxStatus: bird.Ptr(bird.ConversationInboxStatus("resolved"))})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->conversations->update('acv_01krdgeqcxet5s7t44vh8rt9mg', (new Model\AMBConversationUpdate())->setAssignedTo(null)->setLabels([])->setInboxStatus('resolved'));

bird amb conversations update <conversation-id> --body-file - <<'JSON'
{
  "assigned_to": "me",
  "inbox_status": "open",
  "labels": [
    "billing",
    "vip"
  ],
  "queue": "billing",
  "routing_change": {
    "action": "dismiss",
    "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
  }
}
JSON

curl -X PATCH "https://us1.platform.bird.com/v1/amb/conversations/{conversation_id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "assigned_to": "me",
    "inbox_status": "open",
    "labels": [
      "billing",
      "vip"
    ],
    "queue": "billing",
    "routing_change": {
      "action": "dismiss",
      "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
    }
  }'

Réponse200

{
  "inbox_status": "open",
  "routing": {
    "entry_point": "support",
    "queue": "support"
  },
  "routing_change": {
    "entry_point": "billing",
    "queue": "billing",
    "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "last_message": {
    "id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
    "direction": "outbound"
  },
  "id": "acv_01krdgeqcxet5s7t44vh8rt9mg",
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "status": "open",
  "origin": "entry_point",
  "device_capabilities": [
    "QUICK",
    "LIST",
    "TIME"
  ],
  "supported_content_kinds": [
    "text"
  ],
  "locale": "en-US",
  "assigned_to": "usr_01krdgeqcxet5s7t44vh8rt9mg",
  "labels": [
    "billing",
    "vip"
  ],
  "closed_reason": "user_close"
}

Update a conversation

Paramètres

Corps de la requête

Contenu de la réponse

Ressources associées