Skip to main content

Documentation

Add Message to Case Communication Thread

Add a new message to an existing communication thread.

    • thread_token

    • Unique token for communication thread. String starting with comm_.

    • attachments

    • Identifier tokens (strings starting with batch_) of files referenced by this message. The maximum number of files that can be referenced is 5. See also Upload File to Communication Center

    • content

    • The text content of the message.

    • content_structured

    • Includes the ops array, which provides formatting information on the content.

  • v1/threads/:thread_token/messages

  • Add Message to Case Communication Thread

  • curl -X post 'https://api.rapyd.net/v1/threads/comm_5eda2b2651d2a9bda22845aff027ca53/messages' \
    -H 'access_key: your-access-key-here' \
    -H 'Content-Type: application/json' \
    -H 'idempotency: your-idempotency-parameter-here' \
    -H 'salt: your-random-string-here' \
    -H 'signature: your-calculated-signature-here' \
    -H 'timestamp: your-unix-timestamp-here' \
    --data-raw '{
        "content": "Please review these documents",
        "content_structured": {
            "ops": [
                {
                    "insert": "Please review these documents",
                    "attributes": {
                        "bold": true,
                        "underline": true
                    }
                }
            ]
        },
        "attachments": [
            "batch_a2d38836563775b3b84214352bb01e41",
            "batch_415e274c1c31f37c74b6fd7a6e732505"
        ]
    }
    '
     
    
  • {
        "status": {
            "error_code": "",
            "status": "SUCCESS",
            "message": "",
            "response_code": "",
            "operation_id": "037dd31b-4173-464a-b476-e9689d022d3b"
        },
        "data": [
            {
                "comm_token": "comm_5eda2b2651d2a9bda22845aff027ca53",
                "token": "msg_d6600ab008e35ac08c05cce98350d226",
                "content": "Please review these documents",
                "content_structured": {
                    "ops": [
                        {
                            "insert": "Please review these documents",
                            "attributes": {
                                "bold": true,
                                "underline": true
                            }
                        }
                    ]
                },
                "message_direction": "outgoing",
                "attachments": [
                    {
                        "file_id": "377a5b5b-01df-4b24-a8b7-0a3075c6b6f3",
                        "file_name": "2021-07-28_23-56-19.png"
                    },
                    {
                        "file_id": "c31c1f07-7c9a-45f5-847c-470e6811b3ea",
                        "file_name": "2021-08-30_20-13-16.png"
                    }
                ],
                "created_at": 1752493136,
                "updated_at": 1752493136
            }
        ]
    }