Communications

A sent campaign's recipients and how each one fared

Changed on

Requires permission: CommunicationAdmin

Headline counts plus the recipients matching a segment — everybody, those who did not click, those it bounced for, and so on. What the follow-up flow builds its recipient list from.

get/Communications/Campaigns/{id}/Recipients

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/Communications/Campaigns/{id}/Recipients
  • Auth: HTTP bearer

Path parameters

idinteger required

Query parameters

segmentstring nullable

Response

Success

campaignIdinteger
subjectstring nullable
totalinteger
deliveredinteger
openedinteger
clickedinteger
bouncedinteger
complainedinteger
failedinteger

Changes