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

Response

Success - sent or scheduled

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

Changes

Changed in 3 of the 22 revisions of this API.113

  • 5aa4178ca29b1See the full diff
    • ○

      added the new optional request property attachments

      new-optional-request-property

  • df6d21aeebe7111See the full diff
    • ▲

      the recipients/items/ request property type/format changed from string/ to object/

      request-property-type-changed

    • ○

      added the new optional request property audience

      new-optional-request-property

    • ○

      added the new optional request property recipients/items/email

      new-optional-request-property

    • ○

      added the new optional request property recipients/items/fields

      new-optional-request-property

    • ○

      added the new optional request property senderName

      new-optional-request-property

    • ○

      added the optional property campaignId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property emailSent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property errors to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property oneSignalCount to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property provider to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property pushAttempted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property pushDelivered to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 827295df35581See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog