Update conversation message

Update a message

patch

Update a draft conversation message. Sent messages cannot be updated. Setting draft to false causes the draft message to be sent.

Authorizations

accessKey

HTTPRequired

Uses the Authorization header: 'AccessKey ' followed by your access key token (e.g., 'Authorization: AccessKey AbCdEfGhIjKlMnOpQrStUvWxYzAbCdEfGhIj')

Path parameters

workspaceIdstring · uuidRequired

The workspace ID

Example: b4e02c85-c6d2-4b15-8885-e09671799c61

conversationIdstring · uuidRequired

The conversation ID

Example: 67e4d358-ca94-421e-98b7-448860df9d33

messageIdstring · uuidRequired

The message ID

Example: f303d128-0619-49ce-9e2a-669098d7d78b

Body

application/json

draftboolean | nullableOptional

Whether the message is being drafted. Sent messages cannot be turned back into draft.

bodyall of | nullableOptional

and

anyOptional

or

or

or

or

or

or

or

or

or

or

statusstring · enum | nullableOptional

Message status. The lifecycle order is accepted, processing, sent, and delivered.

Possible values:

recipientsone of[] | nullableOptional

List of recipients.

or

addMissingParticipantsbooleanOptional

If enabled, conveniently adds missing participants to the conversation without requiring additional API calls to /participants. It's recommended to set this to true.

replyToMessageIdstring · uuidOptional

The ID of the message to reply to. This is only allowed for draft messages.

Responses

200

OK

application/json

404

The resource specified in the URL was not found

application/json

409

The resource is in a conflicting state

application/json

422

The request body did not pass validation

application/json

patch

/workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId}

HTTPcURLJavaScriptPython

PATCH /workspaces/{workspaceId}/conversations/{conversationId}/messages/{messageId} HTTP/1.1
Host: api.bird.com
Authorization: AccessKey YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 831

{
  "draft": true,
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true,
          "contentId": "text"
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text"
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        },
        "apple": {
          "summaryText": "text"
        }
      }
    }
  },
  "sender": {
    "name": "Bird Support",
    "email": "[email protected]",
    "emailReplyToAddress": "[email protected]"
  },
  "status": "accepted",
  "recipients": [
    {
      "identifierKey": "emailaddress",
      "identifierValue": "[email protected]",
      "platformAddressSelector": "attributes.workEmail",
      "type": "to"
    }
  ],
  "addMissingParticipants": true,
  "replyToMessageId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "aef328e7-6282-4268-a35b-4e5fd9033d2d",
  "conversationId": "0c63be07-3e97-42a3-900a-47e538032b73",
  "reference": "my-own-business-logic-id-12345",
  "sender": {
    "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
    "displayName": "John Doe",
    "avatarUrl": "https://example.bird.com/avatar-url",
    "contact": {
      "identifierKey": "emailaddress",
      "identifierValue": "[email protected]",
      "platformAddress": "[email protected]",
      "platformAddressSelector": "attributes.workEmail"
    },
    "type": "user",
    "status": "active"
  },
  "draft": true,
  "draftMeta": {
    "creatorType": "bot"
  },
  "replyToMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "recipients": [
    {
      "id": "cb22b001-6226-4d7c-acdd-7414b2bcdbaf",
      "type": "to",
      "identifierKey": "emailaddress",
      "identifierValue": "[email protected]",
      "platformAddress": "text",
      "platformAddressSelector": "attributes.workEmail",
      "contactAnnotation": {
        "name": "John Doe"
      },
      "isInbox": true
    }
  ],
  "status": "accepted",
  "source": "conversations",
  "template": {
    "name": "text",
    "projectId": "a1405560-c8d3-4b1a-877d-3f449ad95352",
    "version": "a1405560-c8d3-4b1a-877d-3f449ad95352",
    "locale": "text",
    "attachments": [
      {
        "mediaUrl": "https://example.com",
        "filename": "text",
        "inline": true
      }
    ],
    "shortLinks": {
      "enabled": true,
      "domain": "text"
    },
    "variables": {
      "default": "text",
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "utmParameters": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "parameters": [
      {
        "type": "string",
        "key": "text",
        "value": "text"
      }
    ],
    "settings": {
      "disallowMmLite": true
    }
  },
  "body": {
    "type": "text",
    "text": {
      "text": "text",
      "attachments": [
        {
          "mediaUrl": "https://example.com",
          "filename": "text",
          "inline": true,
          "contentId": "text"
        }
      ],
      "actions": [
        {
          "type": "link",
          "link": {
            "text": "text",
            "url": "text"
          }
        }
      ],
      "metadata": {
        "subject": "text",
        "headers": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "whatsapp": {
          "previewUrl": true
        },
        "line": {
          "emoji": {
            "items": [
              {
                "index": 1,
                "productId": "text",
                "emojiId": "text",
                "length": 1
              }
            ]
          }
        },
        "telegram": {
          "parseMode": "Markdown"
        },
        "apple": {
          "summaryText": "text"
        }
      }
    }
  },
  "reason": "Insufficient credit",
  "interactions": [
    {
      "id": "29f3aab3-ecd7-4a8c-92d3-c3366cfedd79",
      "type": "read",
      "createdAt": "2024-01-01T00:00:00.123Z",
      "metadata": {
        "link": {
          "name": "text",
          "url": "text"
        },
        "button": {
          "payload": "text"
        },
        "reaction": {
          "emoji": "text",
          "action": "text"
        },
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "createdAt": "2024-01-01T00:00:00.123Z",
  "updatedAt": "2024-01-01T00:00:00.123Z",
  "meta": {
    "email": {
      "subject": "text",
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "from": {
        "username": "john.doe",
        "displayName": "John Doe"
      }
    },
    "extraInformation": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "referral": {
      "source": "text",
      "title": "text",
      "text": "text",
      "group": "text",
      "metadata": {
        "sourceId": "120211000000000000",
        "sourceUrl": "https://instagram.com/p/EXAMPLEID",
        "mediaType": "IMAGE",
        "mediaUrl": "https://cdninstagram.com/v/example",
        "caption": "Introducing Dream Summer Days Daily SPF, your go-to sunscreen for safeguarding your skin's glow under the sun's embrace.",
        "username": "DreamCosmetics",
        "timestamp": "2024-11-28T12:00:00.000Z",
        "trackingId": "text"
      }
    }
  },
  "receiverTypes": [
    "to"
  ],
  "inbox": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "identifier": "text",
    "ownerId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerType": "user",
    "type": "personal"
  }
}

Examples

Request

curl -X POST "https://api.bird.com/workspaces/a1405560-c8d3-4b1a-877d-3f449ad95352/conversations/16e1df9e-c6ac-406b-b1ce-13f34d0dea08/messages/884d1fa0-9335-484f-b6ca-96fb7e2c39f9" \
-H "Content-Type: application/json" \
-H "Authorization: AccessKey abcd" \
-d '{
  "draft": false,
  "body": {
    "type": "text",
    "text": {
      "text": "Hey, listen!"
    }
  }
}'

Response (200 - OK)