removedInput schema / properties / body / properties / customSubtypeId
Removed value: -{
- "description": "Custom subtype ID for email unsubscription preferences. Only applies to email messages.",
- "example": "507f1f77bcf86cd799439011",
- "type": "string"
-}
removedInput schema / properties / body / properties / forward
Removed value: -{
- "allOf": [
- {
- "properties": {
- "emailMessageId": {
- "description": "Email Message ID of the specific email being forwarded (source) - Required for single email forward, ignored for thread forward",
- "example": "rnGyqh2F6uBrIkfhFo9A",
- "type": "string"
- },
- "forwardWholeThread": {
- "description": "Specify if forwarding the whole thread or just a single email",
- "example": false,
- "type": "boolean"
- },
- "isForwarded": {
- "description": "Specify if this is a forwarded email",
- "example": true,
- "type": "boolean"
- },
- "messageId": {
- "description": "Message ID of the email thread being forwarded (source) - REQUIRED for forwarding",
- "example": "t22c6DQcTDf3MjRhwf77",
- "type": "string"
- },
- "recipientContactId": {
- "description": "Contact ID of recipient when forwarding (destination)",
- "example": "DEF56h2F6uBrIkfXYacd",
- "type": "string"
- },
- "recipientConversationId": {
- "description": "Conversation ID of recipient when forwarding (destination)",
- "example": "GHI78h2F6uBrIkfXYefg",
- "type": "string"
- },
- "sourceContactId": {
- "description": "Contact ID where the forwarded email originated from (source) - Auto-populated if not provided",
- "example": "ABC12h2F6uBrIkfXYazb",
- "type": "string"
- },
- "sourceConversationId": {
- "description": "Conversation ID where the forwarded email originated from (source) - Auto-populated if not provided",
- "example": "XYZ12h2F6uBrIkfXYacd",
- "type": "string"
- },
- "toEmail": {
- "description": "Email address to forward to (destination)",
- "example": "forward@example.com",
- "type": "string"
- }
- },
- "required": [
- "isForwarded"
- ],
- "type": "object"
- }
- ],
- "description": "Forwarding configuration for emails",
- "example": {
- "emailMessageId": "rnGyqh2F6uBrIkfhFo9A",
- "forwardWholeThread": false,
- "isForwarded": true,
- "messageId": "t22c6DQcTDf3MjRhwf77",
- "recipientContactId": "DEF56h2F6uBrIkfXYacd",
- "toEmail": "forward@example.com"
- }
-}
addedInput schema / properties / body / properties / mentions
Added value: +{
+ "description": "Array of user IDs mentioned in the message. Required for InternalComment type. User IDs correspond to team members tagged with `@username<userId>id</userId>` format in the message text.",
+ "example": [
+ "userId123",
+ "userId456"
+ ],
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+}
changedInput schema / properties / body / properties / message / description
Previous value: -"Text content of the message"New value: +"Text content of the message. For InternalComment type, use `@username<userId>actualUserId</userId>` format to mention team members. The mentioned user IDs must also be included in the mentions array."
removedInput schema / properties / body / properties / optimizationPeriod
Removed value: -{
- "description": "Optimization period in hours (24h, 48h, or 72h)",
- "enum": [
- "24h",
- "48h",
- "72h"
- ],
- "example": "24h",
- "type": "string"
-}
changedInput schema / properties / body / properties / status / description
Previous value: -"Message status"New value: +"Message status. OPTIONAL — reads like a response/inbound-recording field; do not set on a normal outbound send."
removedInput schema / properties / body / properties / status / example
Removed value: -"delivered"
changedInput schema / properties / body / properties / subType / description
Previous value: -"Type of message being sent"New value: +"Message sub-type. OPTIONAL — omit for normal sends. The official spec declares this as an empty object schema and enumerates no valid values (spec gap); the live API validates it as a string enum when the key is present, so only pass a value you know to be valid."
removedInput schema / properties / body / properties / subType / example
Removed value: -"Email"
changedInput schema / properties / body / properties / subType / type
Previous value: -"object"New value: +"string"
changedInput schema / properties / body / properties / type / enum
Previous value: -[
- "SMS",
- "RCS",
- "Email",
- "WhatsApp",
- "IG",
- "FB",
- "Custom",
- "Live_Chat",
- "TIKTOK"
-]New value: +[
+ "SMS",
+ "Email",
+ "WhatsApp",
+ "IG",
+ "FB",
+ "Custom",
+ "Live_Chat",
+ "InternalComment"
+]
addedInput schema / properties / body / properties / userId
Added value: +{
+ "description": "Use this field to specify the user who is making the internal comment when type is 'InternalComment'. If not provided, the comment will be attributed to the system or default user.",
+ "example": "user123",
+ "type": "string"
+}
removedInput schema / properties / body / properties / usesNativeSchedulingAi
Removed value: -{
- "description": "Whether the scheduled email uses native AI for the email scheduling ",
- "example": false,
- "type": "boolean"
-}
addedInput schema / properties / body / properties / whatsapp
Added value: +{
+ "allOf": [
+ {
+ "properties": {
+ "media": {
+ "allOf": [
+ {
+ "properties": {
+ "name": {
+ "description": "File name shown to the recipient.",
+ "example": "sample.png",
+ "type": "string"
+ },
+ "type": {
+ "description": "Kind of media being sent.",
+ "enum": [
+ "image",
+ "video",
+ "audio",
+ "document"
+ ],
+ "example": "image",
+ "type": "string"
+ },
+ "url": {
+ "description": "Publicly reachable URL of the file. Upload via POST /conversations/messages/upload and use the returned URL.",
+ "example": "https://static-assets.internal.usercontent.site/conversations-assets/location/<locationId>/conversations/contact/<contactId>/<uuid>.png",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "url",
+ "name"
+ ],
+ "title": "WhatsAppAttachment",
+ "type": "object"
+ }
+ ],
+ "description": "Media to send. Required when `type` is `media`."
+ },
+ "type": {
+ "description": "Send `media` to deliver an image, video, audio or document. Omit the `whatsapp` object entirely for a text-only message.",
+ "enum": [
+ "media"
+ ],
+ "example": "media",
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "WhatsappPayloadDto",
+ "type": "object"
+ }
+ ],
+ "description": "WhatsApp specific payload. Use this to send media (image, video, audio, document) on a WhatsApp message. Only applies when `type` is `WhatsApp`.",
+ "example": {
+ "media": {
+ "name": "sample.png",
+ "type": "image",
+ "url": "https://static-assets.internal.usercontent.site/conversations-assets/location/<locationId>/conversations/contact/<contactId>/<uuid>.png"
+ },
+ "type": "media"
+ }
+}
changedInput schema / properties / body / required
Previous value: -[
- "type",
- "subType",
- "contactId",
- "status"
-]New value: +[
+ "type",
+ "contactId"
+]
addedInput schema / properties / body / title
Added value: +"SendMessageBodyDto"