Skip to main content Link Search Menu Expand Document (external link)
TextUs Next API

Updated Mon Oct 3rd 2022, 21:22 UTC

Create 

POST /:account/campaigns

Create a new campaign.

  • Campaigns may be given the following optional parameters:
    • auto-assign : a boolean that denotes whether the campaign creator should automatically be assigned to the resulting conversations or not.
    • exclusion_time : if this parameter is passed, there will be a check to see if the recipients of the current campaign have received another campaign message recently. If they have, those recipients will not receive a message from the current campaign. exclusion_time takes an integer that denotes how many minutes in the past from the current campaign’s scheduled_at value to check for those recipients.

Examples

Creating a campaign

Request 

POST /my_account/campaigns

Body 

{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "recipients": [
    "/contact_phones/mxvbRw"
  ]
}
Example 
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/campaigns
    -d '{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "recipients": [
    "/contact_phones/mxvbRw"
  ]
}'

Response

Status

201

Response Type

Campaign

Example Body 

{
  "@type": "Campaign",
  "@context": "/contexts/Campaign.jsonld",
  "id": "/campaigns/joOQd57",
  "title": "The Best Campaign",
  "messageBody": "The best campaign message.",
  "state": "sent",
  "type": "single",
  "schedule": null,
  "createdAt": "2018-11-19T20:51:54.000Z",
  "scheduledAt": "2018-11-19T21:00:54.000Z",
  "sendingStartAt": null,
  "sendingEndAt": null,
  "estimatedStartAt": null,
  "estimatedFinishAt": null,
  "deliveryStatistics": {},
  "delete": "/campaigns/joOQd57",
  "edit": "/campaigns/joOQd57",
  "cancel": "/campaigns/joOQd57/cancel",
  "account": "/accounts/my_account",
  "group": null,
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "totalRecipients": "/campaigns/AJoOVb7/campaign_recipients/total",
  "skippedRecipients": "/campaigns/AJoOVb7/campaign_recipients/skipped",
  "sentRecipients": "/campaigns/AJoOVb7/campaign_recipients/sent",
  "deliveredRecipients": "/campaigns/AJoOVb7/campaign_recipients/delivered",
  "repliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/replied",
  "unrepliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/unreplied",
  "failedRecipients": "/campaigns/AJoOVb7/campaign_recipients/failed",
  "lastSentAt": null,
  "attachments": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/AJoOVb7/campaign_attachments",
    "members": [],
    "totalItems": 0
  },
  "campaignTemplates": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/joOQd57/templates",
    "members": [
      {
        "@type": "CampaignTemplate",
        "@context": "/contexts/CampaignTemplate.jsonld",
        "id": "/campaigns/joOQd57/templates/BYoaNE",
        "sortOrder": 1,
        "messageBody": "hi",
        "attachments": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/AJoOVb7/campaign_attachments",
          "members": [
            {
              "@type": "Attachment",
              "@context": "/contexts/Attachment.jsonld",
              "id": "/campaign_attachments/7LdVlM",
              "url": "https://foo.cloudfront.net/bar1234=",
              "downloadUrl": "https://s3.amazonaws.com/attachments",
              "key": "abc123.png",
              "contentType": "image/png",
              "size": 6829,
              "width": 101,
              "height": 128,
              "originalFilename": "original"
            }
          ],
          "totalItems": 1
        },
        "registeredLinks": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
          "members": [
            {
              "@type": "CampaignRegisteredLink",
              "@context": "/contexts/CampaignRegisteredLink.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
              "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
              "originalLink": "https://xkcd.com",
              "clickCount": 9
            }
          ],
          "totalItems": 1
        },
        "deliveryStatistics": {
          "total": 1,
          "skipped": 0,
          "sent": 1,
          "delivered": 1,
          "replied": 0,
          "unreplied": 1,
          "failed": 0
        },
        "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
        "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
        "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
        "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
        "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
        "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
        "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
      }
    ],
    "totalItems": 1
  }
}

Creating a campaign with an imported contacts filter

Request 

POST /my_account/campaigns

Body 

{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/my_account/contact_filters/import:1pDAaom"
}
Example 
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/campaigns
    -d '{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/my_account/contact_filters/import:1pDAaom"
}'

Response

Status

201

Response Type

Campaign

Example Body 

{
  "@type": "Campaign",
  "@context": "/contexts/Campaign.jsonld",
  "id": "/campaigns/joOQd57",
  "title": "The Best Campaign",
  "messageBody": "The best campaign message.",
  "state": "sent",
  "type": "single",
  "schedule": null,
  "createdAt": "2018-11-19T20:51:54.000Z",
  "scheduledAt": "2018-11-19T21:00:54.000Z",
  "sendingStartAt": null,
  "sendingEndAt": null,
  "estimatedStartAt": null,
  "estimatedFinishAt": null,
  "deliveryStatistics": {},
  "delete": "/campaigns/joOQd57",
  "edit": "/campaigns/joOQd57",
  "cancel": "/campaigns/joOQd57/cancel",
  "account": "/accounts/my_account",
  "group": null,
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "totalRecipients": "/campaigns/AJoOVb7/campaign_recipients/total",
  "skippedRecipients": "/campaigns/AJoOVb7/campaign_recipients/skipped",
  "sentRecipients": "/campaigns/AJoOVb7/campaign_recipients/sent",
  "deliveredRecipients": "/campaigns/AJoOVb7/campaign_recipients/delivered",
  "repliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/replied",
  "unrepliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/unreplied",
  "failedRecipients": "/campaigns/AJoOVb7/campaign_recipients/failed",
  "lastSentAt": null,
  "attachments": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/AJoOVb7/campaign_attachments",
    "members": [],
    "totalItems": 0
  },
  "campaignTemplates": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/joOQd57/templates",
    "members": [
      {
        "@type": "CampaignTemplate",
        "@context": "/contexts/CampaignTemplate.jsonld",
        "id": "/campaigns/joOQd57/templates/BYoaNE",
        "sortOrder": 1,
        "messageBody": "hi",
        "attachments": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/AJoOVb7/campaign_attachments",
          "members": [
            {
              "@type": "Attachment",
              "@context": "/contexts/Attachment.jsonld",
              "id": "/campaign_attachments/7LdVlM",
              "url": "https://foo.cloudfront.net/bar1234=",
              "downloadUrl": "https://s3.amazonaws.com/attachments",
              "key": "abc123.png",
              "contentType": "image/png",
              "size": 6829,
              "width": 101,
              "height": 128,
              "originalFilename": "original"
            }
          ],
          "totalItems": 1
        },
        "registeredLinks": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
          "members": [
            {
              "@type": "CampaignRegisteredLink",
              "@context": "/contexts/CampaignRegisteredLink.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
              "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
              "originalLink": "https://xkcd.com",
              "clickCount": 9
            }
          ],
          "totalItems": 1
        },
        "deliveryStatistics": {
          "total": 1,
          "skipped": 0,
          "sent": 1,
          "delivered": 1,
          "replied": 0,
          "unreplied": 1,
          "failed": 0
        },
        "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
        "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
        "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
        "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
        "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
        "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
        "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
      }
    ],
    "totalItems": 1
  }
}

Creating a campaign with a campaign recipients contacts filter

Request 

POST /my_account/campaigns

Body 

{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/campaigns/joOQd57/campaign_recipients/total/contact_filter"
}
Example 
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/campaigns
    -d '{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/campaigns/joOQd57/campaign_recipients/total/contact_filter"
}'

Response

Status

201

Response Type

Campaign

Example Body 

{
  "@type": "Campaign",
  "@context": "/contexts/Campaign.jsonld",
  "id": "/campaigns/joOQd57",
  "title": "The Best Campaign",
  "messageBody": "The best campaign message.",
  "state": "sent",
  "type": "single",
  "schedule": null,
  "createdAt": "2018-11-19T20:51:54.000Z",
  "scheduledAt": "2018-11-19T21:00:54.000Z",
  "sendingStartAt": null,
  "sendingEndAt": null,
  "estimatedStartAt": null,
  "estimatedFinishAt": null,
  "deliveryStatistics": {},
  "delete": "/campaigns/joOQd57",
  "edit": "/campaigns/joOQd57",
  "cancel": "/campaigns/joOQd57/cancel",
  "account": "/accounts/my_account",
  "group": null,
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "totalRecipients": "/campaigns/AJoOVb7/campaign_recipients/total",
  "skippedRecipients": "/campaigns/AJoOVb7/campaign_recipients/skipped",
  "sentRecipients": "/campaigns/AJoOVb7/campaign_recipients/sent",
  "deliveredRecipients": "/campaigns/AJoOVb7/campaign_recipients/delivered",
  "repliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/replied",
  "unrepliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/unreplied",
  "failedRecipients": "/campaigns/AJoOVb7/campaign_recipients/failed",
  "lastSentAt": null,
  "attachments": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/AJoOVb7/campaign_attachments",
    "members": [],
    "totalItems": 0
  },
  "campaignTemplates": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/joOQd57/templates",
    "members": [
      {
        "@type": "CampaignTemplate",
        "@context": "/contexts/CampaignTemplate.jsonld",
        "id": "/campaigns/joOQd57/templates/BYoaNE",
        "sortOrder": 1,
        "messageBody": "hi",
        "attachments": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/AJoOVb7/campaign_attachments",
          "members": [
            {
              "@type": "Attachment",
              "@context": "/contexts/Attachment.jsonld",
              "id": "/campaign_attachments/7LdVlM",
              "url": "https://foo.cloudfront.net/bar1234=",
              "downloadUrl": "https://s3.amazonaws.com/attachments",
              "key": "abc123.png",
              "contentType": "image/png",
              "size": 6829,
              "width": 101,
              "height": 128,
              "originalFilename": "original"
            }
          ],
          "totalItems": 1
        },
        "registeredLinks": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
          "members": [
            {
              "@type": "CampaignRegisteredLink",
              "@context": "/contexts/CampaignRegisteredLink.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
              "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
              "originalLink": "https://xkcd.com",
              "clickCount": 9
            }
          ],
          "totalItems": 1
        },
        "deliveryStatistics": {
          "total": 1,
          "skipped": 0,
          "sent": 1,
          "delivered": 1,
          "replied": 0,
          "unreplied": 1,
          "failed": 0
        },
        "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
        "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
        "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
        "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
        "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
        "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
        "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
      }
    ],
    "totalItems": 1
  }
}

Creating a campaign with a searched contacts filter

Request 

POST /my_account/campaigns

Body 

{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/my_account/contact_filters/all?q=lucille"
}
Example 
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/campaigns
    -d '{
  "title": "My Beautiful Campaign",
  "message_body": "This is the best message ever.",
  "scheduled_at": "2048-11-19T23:00:00Z",
  "contact_filter": "/my_account/contact_filters/all?q=lucille"
}'

Response

Status

201

Response Type

Campaign

Example Body 

{
  "@type": "Campaign",
  "@context": "/contexts/Campaign.jsonld",
  "id": "/campaigns/joOQd57",
  "title": "The Best Campaign",
  "messageBody": "The best campaign message.",
  "state": "sent",
  "type": "single",
  "schedule": null,
  "createdAt": "2018-11-19T20:51:54.000Z",
  "scheduledAt": "2018-11-19T21:00:54.000Z",
  "sendingStartAt": null,
  "sendingEndAt": null,
  "estimatedStartAt": null,
  "estimatedFinishAt": null,
  "deliveryStatistics": {},
  "delete": "/campaigns/joOQd57",
  "edit": "/campaigns/joOQd57",
  "cancel": "/campaigns/joOQd57/cancel",
  "account": "/accounts/my_account",
  "group": null,
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "totalRecipients": "/campaigns/AJoOVb7/campaign_recipients/total",
  "skippedRecipients": "/campaigns/AJoOVb7/campaign_recipients/skipped",
  "sentRecipients": "/campaigns/AJoOVb7/campaign_recipients/sent",
  "deliveredRecipients": "/campaigns/AJoOVb7/campaign_recipients/delivered",
  "repliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/replied",
  "unrepliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/unreplied",
  "failedRecipients": "/campaigns/AJoOVb7/campaign_recipients/failed",
  "lastSentAt": null,
  "attachments": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/AJoOVb7/campaign_attachments",
    "members": [],
    "totalItems": 0
  },
  "campaignTemplates": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/joOQd57/templates",
    "members": [
      {
        "@type": "CampaignTemplate",
        "@context": "/contexts/CampaignTemplate.jsonld",
        "id": "/campaigns/joOQd57/templates/BYoaNE",
        "sortOrder": 1,
        "messageBody": "hi",
        "attachments": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/AJoOVb7/campaign_attachments",
          "members": [
            {
              "@type": "Attachment",
              "@context": "/contexts/Attachment.jsonld",
              "id": "/campaign_attachments/7LdVlM",
              "url": "https://foo.cloudfront.net/bar1234=",
              "downloadUrl": "https://s3.amazonaws.com/attachments",
              "key": "abc123.png",
              "contentType": "image/png",
              "size": 6829,
              "width": 101,
              "height": 128,
              "originalFilename": "original"
            }
          ],
          "totalItems": 1
        },
        "registeredLinks": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
          "members": [
            {
              "@type": "CampaignRegisteredLink",
              "@context": "/contexts/CampaignRegisteredLink.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
              "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
              "originalLink": "https://xkcd.com",
              "clickCount": 9
            }
          ],
          "totalItems": 1
        },
        "deliveryStatistics": {
          "total": 1,
          "skipped": 0,
          "sent": 1,
          "delivered": 1,
          "replied": 0,
          "unreplied": 1,
          "failed": 0
        },
        "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
        "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
        "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
        "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
        "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
        "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
        "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
      }
    ],
    "totalItems": 1
  }
}

API user creates campaign from group ID

Request 

POST /my_account/campaigns

Body 

{
  "title": "The Best Campaign",
  "message_body": "The best campaign message.",
  "contact_collection": "<%= group_contacts_path(groups(:my_group)) %>"
}
Example 
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /my_account/campaigns
    -d '{
  "title": "The Best Campaign",
  "message_body": "The best campaign message.",
  "contact_collection": "<%= group_contacts_path(groups(:my_group)) %>"
}'

Response

Status

201

Response Type

Campaign

Example Body 

{
  "@type": "Campaign",
  "@context": "/contexts/Campaign.jsonld",
  "id": "/campaigns/joOQd57",
  "title": "The Best Campaign",
  "messageBody": "The best campaign message.",
  "state": "sent",
  "type": "single",
  "schedule": null,
  "createdAt": "2018-11-19T20:51:54.000Z",
  "scheduledAt": "2018-11-19T21:00:54.000Z",
  "sendingStartAt": null,
  "sendingEndAt": null,
  "estimatedStartAt": null,
  "estimatedFinishAt": null,
  "deliveryStatistics": {},
  "delete": "/campaigns/joOQd57",
  "edit": "/campaigns/joOQd57",
  "cancel": "/campaigns/joOQd57/cancel",
  "account": "/accounts/my_account",
  "group": "/groups/joOQd57",
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "totalRecipients": "/campaigns/AJoOVb7/campaign_recipients/total",
  "skippedRecipients": "/campaigns/AJoOVb7/campaign_recipients/skipped",
  "sentRecipients": "/campaigns/AJoOVb7/campaign_recipients/sent",
  "deliveredRecipients": "/campaigns/AJoOVb7/campaign_recipients/delivered",
  "repliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/replied",
  "unrepliedRecipients": "/campaigns/AJoOVb7/campaign_recipients/unreplied",
  "failedRecipients": "/campaigns/AJoOVb7/campaign_recipients/failed",
  "lastSentAt": null,
  "attachments": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/AJoOVb7/campaign_attachments",
    "members": [],
    "totalItems": 0
  },
  "campaignTemplates": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/campaigns/joOQd57/templates",
    "members": [
      {
        "@type": "CampaignTemplate",
        "@context": "/contexts/CampaignTemplate.jsonld",
        "id": "/campaigns/joOQd57/templates/BYoaNE",
        "sortOrder": 1,
        "messageBody": "hi",
        "attachments": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/AJoOVb7/campaign_attachments",
          "members": [
            {
              "@type": "Attachment",
              "@context": "/contexts/Attachment.jsonld",
              "id": "/campaign_attachments/7LdVlM",
              "url": "https://foo.cloudfront.net/bar1234=",
              "downloadUrl": "https://s3.amazonaws.com/attachments",
              "key": "abc123.png",
              "contentType": "image/png",
              "size": 6829,
              "width": 101,
              "height": 128,
              "originalFilename": "original"
            }
          ],
          "totalItems": 1
        },
        "registeredLinks": {
          "@type": "hydra:Collection",
          "@context": "/contexts/hydra:Collection.jsonld",
          "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links",
          "members": [
            {
              "@type": "CampaignRegisteredLink",
              "@context": "/contexts/CampaignRegisteredLink.jsonld",
              "id": "/campaigns/bK9DjpX/templates/bK9DjpX/links/BYoaNE",
              "shortLink": "https://cattaps.textus-stg.app/6Tb1mk",
              "originalLink": "https://xkcd.com",
              "clickCount": 9
            }
          ],
          "totalItems": 1
        },
        "deliveryStatistics": {
          "total": 1,
          "skipped": 0,
          "sent": 1,
          "delivered": 1,
          "replied": 0,
          "unreplied": 1,
          "failed": 0
        },
        "totalRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/total",
        "skippedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/skipped",
        "sentRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/sent",
        "deliveredRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/delivered",
        "failedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/failed",
        "repliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/replied",
        "unrepliedRecipients": "/campaigns/joOQd57/templates/joOQd57/recipients/unreplied"
      }
    ],
    "totalItems": 1
  }
}

© 2022 TextUs