digitaluapi

<back to all web services

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST/campaign/inbox/form
SaveCampaignActionClientForm Parameters:
NameParameterData TypeRequiredDescription
CommsGuidbodyGuidNo
CampaignActionsRequestsIdbodylongNo
CommentsbodystringNo
CampaignActionFilesbodyList<CampaignActionFile>No
CampaignActionFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileTypeformstringNo
FileSizeformstringNo
ExtensionformstringNo
UploadUrlformstringNo
SaveCampaignActionClientFormResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignActionsFormResponsesformCampaignActionsFormResponsesNo
ResponseStatusformResponseStatusNo
CampaignActionsFormResponses Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CampaignActionsIdformlongYes
CustomersIdformlong?No
ActionTimestampformDateTimeOffsetYes
FormMetaResponsesformCampaignActionFormResultsNo
FormMetaCustomResponsesformDictionary<string, string>No
CampaignInstanceCommsIdformlong?No
FormMetaFilesResponsesformList<CampaignActionFile>No
FormMetaCommentsformstringNo
StatusCodesIdformintNo
SentToEmailAddressformstringNo
VersionNumberformintNo
CampaignActionFormResults Parameters:
NameParameterData TypeRequiredDescription
CustomFormResultsformstringNo
CommentsformstringNo
CampaignActionFilesformList<CampaignActionFile>No

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 /campaign/inbox/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CommsGuid":"00000000000000000000000000000000","CampaignActionsRequestsId":0,"Comments":"String","CampaignActionFiles":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CampaignActionsFormResponses":{"Id":0,"CampaignActionsId":0,"CustomersId":0,"ActionTimestamp":"0001-01-01T00:00:00.0000000+00:00","FormMetaResponses":{"CustomFormResults":"String","Comments":"String","CampaignActionFiles":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}]},"FormMetaCustomResponses":{"String":"String"},"CampaignInstanceCommsId":0,"FormMetaFilesResponses":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}],"FormMetaComments":"String","StatusCodesId":0,"SentToEmailAddress":"String","VersionNumber":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}