v7

OpenAPI 3.0.02026-08-046241,3352.0 MB

Communications

Send or schedule a campaign

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 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,
  "recipients": []
}

Response

Success - sent or scheduled

recipientCountinteger

scheduledboolean

scheduledForstring date-time nullable

campaignIdinteger

providerstring

pushAttemptedinteger

pushDeliveredinteger

oneSignalCountinteger

emailSentinteger

errorsstring[]