Send Message to Participant

curl -X POST "https://api-v3.sweeppea.com/messaging/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "ParticipantToken": "uuid-v4-string",
        "Channel": "both",
        "Subject": "About your entry",
        "Message": "Hi Jane, thanks for entering! Winners are announced on October 15.",
        "IdempotencyKey": "crm-msg-000481"
    }'

const response = await fetch('https://api-v3.sweeppea.com/messaging/send', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    ParticipantToken: "uuid-v4-string",
    Channel: "both",
    Subject: "About your entry",
    Message: "Hi Jane, thanks for entering! Winners are announced on October 15.",
    IdempotencyKey: "crm-msg-000481"
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://api-v3.sweeppea.com/messaging/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "ParticipantToken": "uuid-v4-string",
    "Channel": "both",
    "Subject": "About your entry",
    "Message": "Hi Jane, thanks for entering! Winners are announced on October 15.",
    "IdempotencyKey": "crm-msg-000481"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

{
  "Response": true,
  "Telemetry": {
    "DataConsumed": 0,
    "APICalls": 312,
    "MaxAPICalls": 1500000
  },
  "Data": {
    "ParticipantToken": "uuid-v4-string",
    "NotificationId": "66f8a1c2e4b0a91d2c3e4f50",
    "Duplicate": false,
    "Channels": [
      {
        "Channel": "email",
        "Status": "queued",
        "MessageToken": "uuid-v4-string"
      },
      {
        "Channel": "sms",
        "Status": "skipped",
        "Reason": "NoAddress",
        "Message": "The participant has no valid phone number."
      }
    ]
  },
  "Message": "Message queued. It is delivered within about a minute (SMS outside quiet hours)."
}

{
  "Response": true,
  "Telemetry": {
    "DataConsumed": 0,
    "APICalls": 312,
    "MaxAPICalls": 1500000
  },
  "Data": {
    "ParticipantToken": "uuid-v4-string",
    "NotificationId": "66f8a1c2e4b0a91d2c3e4f50",
    "Duplicate": true,
    "Channels": [
      {
        "Channel": "email",
        "Status": "delivered",
        "MessageToken": "uuid-v4-string"
      }
    ]
  },
  "Message": "This message was already queued with the same IdempotencyKey. Nothing new was sent."
}

{
  "Response": false,
  "Message": "Missing required parameter: ParticipantToken",
  "Code": 400,
  "Help": {
    "ExpectedBody": {
      "ParticipantToken": "string (required) — UUID v4 of a participant (regular or AMOE) of your account",
      "Channel": "string (required) — email | sms | both. \"both\" sends on each channel the participant has an address for",
      "Message": "string (required) — The message. Plain text, max 5000 characters (1600 for SMS)",
      "Subject": "string (optional) — Email subject, max 200 characters. Defaults to a generic subject",
      "IdempotencyKey": "string (optional) — 8 to 64 characters [A-Za-z0-9_-]. Retrying with the same key never sends twice",
      "CalledFromMCP": "boolean (optional) — Set by the MCP server, ignore it",
      "CalledFromCLI": "boolean (optional) — Set by the CLI, ignore it"
    }
  }
}

{
  "Response": false,
  "Message": "Direct messages through the API are not enabled for your account yet. Contact Sweeppea support to enable them.",
  "Code": 403,
  "Data": {
    "Code": "DirectMessageNotEnabled"
  }
}

{
  "Response": false,
  "Message": "SMS requires a registered and validated 10DLC number on your account.",
  "Code": 403,
  "Data": {
    "Code": "NoRegisteredSmsSender"
  }
}

{
  "Response": false,
  "Message": "Participant not found. The ParticipantToken must exist and belong to your account.",
  "Code": 404
}

{
  "Response": false,
  "Message": "This message cannot be sent: it contains prohibited content (fraud). Remove it and try again.",
  "Code": 422,
  "Data": {
    "Code": "ProhibitedContent",
    "Categories": [
      "FRAUD"
    ]
  }
}

{
  "Response": false,
  "Message": "Nothing was sent. See Data.Channels for the reason on each channel.",
  "Code": 422,
  "Data": {
    "Channels": [
      {
        "Channel": "email",
        "Status": "skipped",
        "Reason": "Suppressed",
        "Message": "This address is on the suppression list (it unsubscribed, replied STOP, complained, bounced or was added by you)."
      }
    ]
  }
}

{
  "Response": false,
  "Message": "Daily limit reached: at most 200 direct messages per 24 hours through the API. Use a campaign in the Sweeppea app for bulk sends.",
  "Code": 429,
  "Data": {
    "Code": "AccountDailyLimit",
    "Limit": 200
  }
}

{
  "Response": false,
  "Message": "Missing or invalid Bearer token. Send your API token in the Authorization header as: Authorization: Bearer YOUR_API_TOKEN",
  "Code": 401
}

{
  "Response": false,
  "Message": "Invalid API token. It does not match any account.",
  "Code": 403
}

{
  "Response": false,
  "Message": "The Send Message module is not enabled for your account. Contact support to enable it.",
  "Code": 403
}

{
  "Response": false,
  "Message": "Rate limit exceeded. Your plan allows 60 API calls per minute. Wait a few seconds and try again.",
  "Code": 429
}

{
  "Response": false,
  "Message": "Internal server error. Please try again; if it persists, contact support with the time of this request.",
  "Code": 500
}