Communications

Send or schedule a campaign

Changed on

Requires permission: CommunicationAdmin

Sends a push and/or email to a resolved recipient list, immediately or scheduled for a future time (queued as a job). Each recipient carries merge fields; the subject/body/link support {{tokens}} substituted per recipient. Records the send on CORE_Campaigns.

post/Communications/Campaign

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Communications/Campaign
  • Auth: HTTP bearer

Request body

subjectstring nullable
bodystring nullable
linkTostring nullable
borderColourstring nullable
interruptionLevelinteger
sendPushboolean
sendEmailboolean
replyTostring nullable
senderNamestring nullable
audiencestring nullable
scheduledForstring date-time nullable

Example request

{
  "interruptionLevel": 0,
  "sendPush": true,
  "sendEmail": false,
  "attachments": [],
  "recipients": []
}

Response

Success - sent or scheduled

recipientCountinteger
scheduledboolean
scheduledForstring date-time nullable
campaignIdinteger
pushAttemptedinteger
pushDeliveredinteger
emailSentinteger
errorsstring[]

Changes

  • f603c2364e05Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

  • 5aa4178ca29bRevision changes
    • info

      added the new optional request property