Name | Description | Type | Additional Info |
---|---|---|---|
standardCampaignId | The ID of the standard campaign. | globally unique identifier | Required |
None.
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} |
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} |
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} |
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. |
Sample:
{ "StandardCampaignSends": [ { "StandardCampaignSendId": "3213f878-370b-4c83-997b-14bf76ee0464", "StandardCampaignId": "09ba251f-54fc-4156-92b5-95a160d5a439", "HasEmail": true, "HasFax": true, "HasSms": true, "Name": "sample string 5", "SendDate": "2025-01-18T05:19:49.3986556+00:00", "Status": "sample string 4", "SubjectLine": "sample string 8" }, { "StandardCampaignSendId": "3213f878-370b-4c83-997b-14bf76ee0464", "StandardCampaignId": "09ba251f-54fc-4156-92b5-95a160d5a439", "HasEmail": true, "HasFax": true, "HasSms": true, "Name": "sample string 5", "SendDate": "2025-01-18T05:19:49.3986556+00:00", "Status": "sample string 4", "SubjectLine": "sample string 8" } ], "NextPageUrl": "sample string 1", "PageIndex": 1, "PageSize": 1, "TotalPages": 1, "TotalResults": 1, "Error": { "ErrorId": 1, "ErrorMessage": "sample string 1" } }
Sample:
/**/ typeof === 'function' && ({"StandardCampaignSends":[{"StandardCampaignSendId":"3213f878-370b-4c83-997b-14bf76ee0464","StandardCampaignId":"09ba251f-54fc-4156-92b5-95a160d5a439","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:49.3986556+00:00","Status":"sample string 4","SubjectLine":"sample string 8"},{"StandardCampaignSendId":"3213f878-370b-4c83-997b-14bf76ee0464","StandardCampaignId":"09ba251f-54fc-4156-92b5-95a160d5a439","HasEmail":true,"HasFax":true,"HasSms":true,"Name":"sample string 5","SendDate":"2025-01-18T05:19:49.3986556+00:00","Status":"sample string 4","SubjectLine":"sample string 8"}],"NextPageUrl":"sample string 1","PageIndex":1,"PageSize":1,"TotalPages":1,"TotalResults":1,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});