Retrieve Published Messages

POST

https://client-api.nudgescribe.com/v1/messages/fetch

ContentCampaignCampaign MessagesRetrieveRetrieve MessagesMessagesFiles

Downloads a specific exported message file in the requested format. Supports three output formats: raw UTF-8 CSV content, parsed JSON array, or a pre-signed URL for direct download.
Provides flexible options for retrieving exported message data, accommodating different integration requirements and use cases.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢200JSON Format

application/json

Body

🟢200UTF-8 Format

🟢200URL Format

🟠400

🟠401Missing Fields

🟠401Campaign Not Found

🟠401Invalid Export Type

🟠403Unauthorised

🟠404File Not Found

🔴500

🔴500Parse Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://client-api.nudgescribe.com/v1/messages/fetch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaign_id": "your-campaign-uuid",
    "file_num": 0,
    "export_type": "json"
}'

Response Example

200 - JSON Format

{
    "data": [
        {
            "customer_id": "jane-customer-uuid",
            "message": "Opening: Hey Jane, \nBody/value: Your quick 2-minute survey helps us improve. Complete it to claim a R2000 Takealot voucher.\nCTA: Tap the link to begin now.\nClosing: Reply STOP to opt out.\nAct now—voucher eligibility is time-sensitive."
        },
        {
            "customer_id": "john-customer-uuid",
            "message": "Opening: Hey John, \nBody/value: Your quick 2-minute survey helps us improve. Complete it to claim a R2000 Takealot voucher.\nCTA: Tap the link to begin now.\nClosing: Reply STOP to opt out.\nAct now—voucher eligibility is time-sensitive."
        }
    ]
}

Modified at 2026-01-30 13:24:06

Get Campaign Messages Pages