Link Search Menu Expand Document

Updated Fri Jun 18th 2021, 16:17 UTC

Get Contact Filter

GET /campaigns/:campaign/campaign_recipients/:recipient_filter/contact_filter

A RecipientContactFilter wraps campaign recipients back into their associated contacts in order to send more campaigns to them

Examples

Get a Contact Filter

Request

GET /campaigns/joOQd57/campaign_recipients/total/contact_filter
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /campaigns/joOQd57/campaign_recipients/total/contact_filter
    

Response

Status

200

Response Type

RecipientContactFilter

Example
{
  "@type": "RecipientContactFilter",
  "id": "/campaigns/joOQd57/campaign_recipients/total/contact_filter",
  "@context": "/contexts/RecipientContactFilter.jsonld",
  "slug": "all",
  "title": "My Contacts",
  "path": null,
  "contacts": "/campaigns/joOQd57/campaign_recipients/total/contact_filter/contacts",
  "blockContacts": "/campaigns/joOQd57/campaign_recipients/total/block",
  "unblockContacts": "/campaigns/joOQd57/campaign_recipients/total/block",
  "unsubscribeContacts": "/campaigns/joOQd57/campaign_recipients/total/subscribe",
  "subscribeContacts": "/campaigns/joOQd57/campaign_recipients/total/subscribe",
  "removeContacts": null
}

© 2021 TextUs