Skip to main content

Send

POST 
/api/SendMessage_V3/PartnerRoute

This action supports delivery of message content based on customer configured routing rules on a per contact basis.

In your request, you can include content for:

  • SMS
  • Email
  • Push Notification
  • Eduspot Timeline

This API method will examine the customer/recipient routing configuration and determine the relevant content to deliver to each defined recipient, based on the customer's configuration in the Groupcall or Teachers2Parents platform.

When working with schools, it is recommended to include content for all routes to ensure greatest flexibility based on the customer's configuration and local data.

When identifying your recipient, the IdaasId property is preferred. It is the unique person identifier in scope of the school obtained from Xporter Data. It can also be constructed with a consistent prefix per person type and MISID.

PersonTypePrefix
StudentPL-
Student ContactPC-
StaffPWT-

When working with other organisations or anonymous recipients, provide content for the message type you intend to send eg SMS only.

Request​

Responses​