Retrieve Published Messages

POST

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

ContentCampaignCampaign MessagesRetrieveRetrieve MessagesMessagesFiles

Retrieves campaign message files in various formats including, raw UTF-8 CSV, parsed JSON, or secure download URLs.
Provides flexible access to stored message files with multiple export options to support different integration patterns.

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

🟢200Success

application/json

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://client-api.dev.nudgescribe.com/v1/messages/fetch' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaign_id": "c93c0e65-6191-44e5-9031-147ff5be0429",
    "file_num": 0,
    "export_type": "json"
}'

Response Example

200 - Json Format Type Example

{
    "data": [
        {
            "customer_id": "01K42N9SX8CGB5Z8JVPS1Y5VYX",
            "message": {
                "email_subject": "Personal loan offer for Beryle (51 yrs)",
                "introduction": "Hi Honorable Cossom, hope you’re well. Here’s a loan option with a wink—no guarantees, just potential.",
                "paragraph_one": "This offer is real but not a guaranteed approval. Pick a loan amount that fits your budget.",
                "paragraph_two": "Next steps: if you're interested, we’ll verify your identity and run a standard check. We’ll never ask for PINs or passwords.",
                "paragraph_three": "For ages 50-59, it can help with debt consolidation, home projects, or emergencies.",
                "closing": "Opt out anytime by replying STOP. This message is from Beryle Cossom (ID 01K42N9SX8CGB5Z8JVPS1Y5VYX), date acquired <date_acquired>. Regards, Your Lending Team"
            }
        },
        {
            "customer_id": "01K42N9SX93ZQGTAPDQYS52YYA",
            "message": {
                "email_subject": "Personal loan offer for Lukas (54 yrs)",
                "introduction": "Hi Honorable Cuskery, hope you’re well. Here’s a loan option with a wink—no guarantees, just potential.",
                "paragraph_one": "This offer is real but not a guaranteed approval. Pick a loan amount that fits your budget.",
                "paragraph_two": "Next steps: if you're interested, we’ll verify your identity and run a standard check. We’ll never ask for PINs or passwords.",
                "paragraph_three": "For ages 50-59, it can help with debt consolidation, home projects, or emergencies.",
                "closing": "Opt out anytime by replying STOP. This message is from Lukas Cuskery (ID 01K42N9SX93ZQGTAPDQYS52YYA), date acquired <date_acquired>. Regards, Your Lending Team"
            }
        }
    ]
}

Modified at 2025-10-31 14:13:12

Publish Messages to Secure Storage

Get Campaign Messages Pages