digitaluapi

SaveCampaignActionClientCustomForm

The following routes are available for this service:
PUT POST	/campaign/inbox/customform

**SaveCampaignActionClientCustomForm** Parameters:
Name	Parameter	Data Type	Required
CommsGuid	body	Guid	No
CampaignActionsRequestsId	body	long	No
CustomFormResults	body	Dictionary<string, string>	No

**SaveCampaignActionClientFormResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignActionsFormResponses	form	CampaignActionsFormResponses	No
ResponseStatus	form	ResponseStatus	No

**CampaignActionsFormResponses** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
CampaignActionsId	form	long	Yes
CustomersId	form	long?	No
ActionTimestamp	form	DateTimeOffset	Yes
FormMetaResponses	form	CampaignActionFormResults	No
FormMetaCustomResponses	form	Dictionary<string, string>	No
CampaignInstanceCommsId	form	long?	No
FormMetaFilesResponses	form	List<CampaignActionFile>	No
FormMetaComments	form	string	No
StatusCodesId	form	int	No
SentToEmailAddress	form	string	No
VersionNumber	form	int	No

**CampaignActionFormResults** Parameters:
Name	Parameter	Data Type	Required
CustomFormResults	form	string	No
Comments	form	string	No
CampaignActionFiles	form	List<CampaignActionFile>	No

**CampaignActionFile** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
FileType	form	string	No
FileSize	form	string	No
Extension	form	string	No
UploadUrl	form	string	No

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

HTTP + JSV

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

POST /campaign/inbox/customform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommsGuid: 00000000000000000000000000000000,
	CampaignActionsRequestsId: 0,
	CustomFormResults: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}