YM REST Services

<back to all web services

Campaigns

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/Campaigns/{CampaignId}/SendTestSend the test email.
GET,POST/Ams/{ClientID}/CampaignsReturn a list of Email Campaigns and their data.
GET/Ams/{ClientID}/Campaigns/{CampaignId}Return the details of a given Email Campaign.
PUT/Ams/{ClientID}/Campaigns/{CampaignId}Update a given Email Campaign.
DELETE/Ams/{ClientID}/Campaigns/{CampaignId}Delete a given Email Campaign.
Campaigns Parameters:
NameParameterData TypeRequiredDescription
CampaignIdpathintNo
ListIdbodyintNo
CategoryIdbodyintNo
CampaignNamebodystringNo
TestRecipientEmailbodystringNo
SubjectbodystringNo
EmailPreviewbodystringNo
SenderEmailbodystringNo
MarkupIdbodyintNo
DateScheduledbodyDateTime?No
PageSizebodyintNo
PageNumberbodyintNo
CampaignStatusbodyBulkEmailStatusNo
IsNewsLettersbodyboolNo
NewNamebodystringNo
OrderBybodystringNo
OrderByDirectionbodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CampaignsResponse Parameters:
NameParameterData TypeRequiredDescription
DateStartProcessingformDateTime?No
DateEndProcessingformDateTime?No
DateJobSubmittedformDateTimeNo
ListNameformstringNo
ListAreaformEmailListAreaNo
EmailCategoryNameformstringNo
AdminNameformstringNo
AdminCommentsformstringNo
TotalCountformintNo
CampaignsformList<CampaignData>No
HasCampaignActivityExpiredformboolNo
DateCampaignActivityExpirationformDateTime?No
VersionformintNo
PreservedListIdAndNameformstringNo
CampaignData Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CampaignNameformstringNo
DateCreatedformDateTimeNo
DateScheduledformDateTime?No
CampaignStatusformBulkEmailStatusNo
SubjectformstringNo
CategoryNameformstringNo
CategoryIdformintNo
MarkupIdformintNo
ProcessedformintNo
VersionformintNo
HasCampaignExpiredformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Campaigns/{CampaignId}/SendTest HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CampaignId":0,"ListId":0,"CategoryId":0,"CampaignName":"String","TestRecipientEmail":"String","Subject":"String","EmailPreview":"String","SenderEmail":"String","MarkupId":0,"DateScheduled":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"CampaignStatus":"InQueue","IsNewsLetters":false,"NewName":"String","OrderBy":"String","OrderByDirection":"String","UsingRedis":true,"AppInitTime":"2025-01-15T08:45:58.7643568-05:00","ServerID":"WS-6-64-014","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T09:03:18.7442554-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"DateStartProcessing":"0001-01-01T00:00:00.0000000","DateEndProcessing":"0001-01-01T00:00:00.0000000","DateJobSubmitted":"0001-01-01T00:00:00.0000000","ListName":"String","ListArea":"None","EmailCategoryName":"String","AdminName":"String","AdminComments":"String","TotalCount":0,"Campaigns":[{"Id":0,"CampaignName":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateScheduled":"0001-01-01T00:00:00.0000000","CampaignStatus":"InQueue","Subject":"String","CategoryName":"String","CategoryId":0,"MarkupId":0,"Processed":0,"Version":0,"HasCampaignExpired":false}],"HasCampaignActivityExpired":false,"DateCampaignActivityExpiration":"0001-01-01T00:00:00.0000000","Version":0,"PreservedListIdAndName":"String","CampaignId":0,"ListId":0,"CategoryId":0,"CampaignName":"String","TestRecipientEmail":"String","Subject":"String","EmailPreview":"String","SenderEmail":"String","MarkupId":0,"DateScheduled":"0001-01-01T00:00:00.0000000","PageSize":0,"PageNumber":0,"CampaignStatus":"InQueue","IsNewsLetters":false,"NewName":"String","OrderBy":"String","OrderByDirection":"String","UsingRedis":true,"AppInitTime":"2025-01-15T08:45:58.7643568-05:00","ServerID":"WS-6-64-014","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2025-01-15T09:03:18.7607145-05:00","Device":"Desktop"}