| GET | /campaign/inbox/formmeta |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommsGuid | query | Guid | No | |
| CampaignActionsRequestsId | query | long | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| campaignAction | form | CampaignActions | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | long | Yes | |
| CampaignsId | form | long | Yes | |
| ActionsId | form | long? | No | |
| ButtonName | form | string | No | |
| ActionTypesId | form | int? | No | |
| Description | form | string | No | |
| OfferOrder | form | short? | No | |
| StandOut | form | bool? | No | |
| PublicAccessGuid | form | Guid | Yes | |
| FormMeta | form | List<FormField> | No | |
| Files | form | List<CampaignActionFile> | No | |
| SentToEmailAddress | form | string | No | |
| CcEmailAddress | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ControlType | form | string | No | |
| Label | form | string | No | |
| Placeholder | form | string | No | |
| Help | form | string | No | |
| Name | form | string | No | |
| SortOrder | form | int | No | |
| Options | form | List<FormFieldOption> | No | |
| Validation | form | List<string> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | No | |
| Label | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /campaign/inbox/formmeta HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"campaignAction":{"Id":0,"CampaignsId":0,"ActionsId":0,"ButtonName":"String","ActionTypesId":0,"Description":"String","OfferOrder":0,"StandOut":false,"PublicAccessGuid":"00000000000000000000000000000000","FormMeta":[{"Id":0,"ControlType":"String","Label":"String","Placeholder":"String","Help":"String","Name":"String","SortOrder":0,"Options":[{"Value":"String","Label":"String"}],"Validation":["String"]}],"Files":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}],"SentToEmailAddress":"String","CcEmailAddress":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}