GET v3/standardcampaigns/{standardCampaignId}/sends

https://api.questline.com/v3/standardcampaigns/{standardCampaignId}/sends

Gets a list of standard campaign sends for a standard campaign.

Request Information

URI Parameters

Name Description Type Additional Info
standardCampaignId The ID of the standard campaign. globally unique identifier Required

Body Parameters

None.

Filters

Name Description Usage
hasEmail Filters the request by the has email flag. GET v3/standardcampaigns/{standardCampaignId}/sends?filter=hasemail~{operator}~{value}
hasFax Filters the request by the has fax flag. GET v3/standardcampaigns/{standardCampaignId}/sends?filter=hasfax~{operator}~{value}
hasSms Filters the request by the has SMS flag. GET v3/standardcampaigns/{standardCampaignId}/sends?filter=hassms~{operator}~{value}
name Filters the request by name. GET v3/standardcampaigns/{standardCampaignId}/sends?filter=name~{operator}~{value}
sendDate Filters the request by send date. GET v3/standardcampaigns/{standardCampaignId}/sends?filter=senddate~{operator}~{value}

Sorting

Name Description Usage
name Sorts the request by name. GET v3/standardcampaigns/{standardCampaignId}/sends?sort=name~{direction}
sendDate Sorts the request by send date. GET v3/standardcampaigns/{standardCampaignId}/sends?sort=senddate~{direction}

Paging

Name Description Usage
index The index to retrieve when requesting paged results. GET v3/standardcampaigns/{standardCampaignId}/sends?page=index~{value}
size The size of the page when requesting paged results. GET v3/standardcampaigns/{standardCampaignId}/sends?page=size~{value}

Response Information

Resource Description

GetStandardCampaignSendsResponseV3
Name Description Type Additional Info
StandardCampaignSends The list of standard campaign sends. Collection of StandardCampaignSendV3 None.
NextPageUrl The URL of the next page of data for the list. string None.
PageIndex The index of the requested page. integer None.
PageSize The size of the requested page. integer None.
TotalPages The total number of pages, based on total results and page size. integer None.
TotalResults The total number of results. integer None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "StandardCampaignSends": [
    {
      "StandardCampaignSendId": "4ec80979-6b71-4965-ad6d-a50360e537c5",
      "StandardCampaignId": "fdf94a12-b841-4121-9de4-10af8b752750",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "Name": "sample string 6",
      "SendDate": "2024-04-25T08:45:54.23611+00:00",
      "Status": "sample string 7",
      "SubjectLine": "sample string 8"
    },
    {
      "StandardCampaignSendId": "4ec80979-6b71-4965-ad6d-a50360e537c5",
      "StandardCampaignId": "fdf94a12-b841-4121-9de4-10af8b752750",
      "HasEmail": true,
      "HasFax": true,
      "HasSms": true,
      "Name": "sample string 6",
      "SendDate": "2024-04-25T08:45:54.23611+00:00",
      "Status": "sample string 7",
      "SubjectLine": "sample string 8"
    }
  ],
  "NextPageUrl": "sample string 1",
  "PageIndex": 1,
  "PageSize": 1,
  "TotalPages": 1,
  "TotalResults": 1,
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"StandardCampaignSends":[{"StandardCampaignSendId":"4ec80979-6b71-4965-ad6d-a50360e537c5","StandardCampaignId":"fdf94a12-b841-4121-9de4-10af8b752750","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 6","SendDate":"2024-04-25T08:45:54.23611+00:00","Status":"sample string 7","SubjectLine":"sample string 8"},{"StandardCampaignSendId":"4ec80979-6b71-4965-ad6d-a50360e537c5","StandardCampaignId":"fdf94a12-b841-4121-9de4-10af8b752750","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 6","SendDate":"2024-04-25T08:45:54.23611+00:00","Status":"sample string 7","SubjectLine":"sample string 8"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});