Archive a form

post

/api/REST/2.0/assets/form/{id}/archive

Archives the form specified by the id parameter.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the parameters for archiving the form.
Root Schema : ArchiveParameter
Type: object
Title: ArchiveParameter
Show Source
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : Form
Type: object
Title: Form
Show Source
Nested Schema : FormFieldUpdateMapping
Type: object
Title: FormFieldUpdateMapping
Show Source
Nested Schema : elements
Type: array
Array consisting of form elements.
Show Source
Nested Schema : permissions
Type: array
The permissions for the form granted to your current instance. This is a read-only property.
Show Source
Nested Schema : processingSteps
Type: array
A list of the form's processing steps. There is no limit to the number of processing steps that can be included. Possible values include: FormStepAddToCampaign, FormStepAddToContactList, FormStepAddToDataCanvas, FormStepAddToProgram, FormStepAssociateToCampaign, FormStepCancelRegistration, FormStepUpdateContactEmailAddress, FormStepCreateUpdateEventRegistration, FormStepCreateUpdate, FormStepCreateUpdateFromFormField, FormStepGlobalSubscribe, FormStepGlobalUnsubscribe, FormStepGroupSubscription, FormStepPostData, FormStepRedirectToWebPage, FormStepRemoveFromContactList, FormStepRunIntegrationRules, FormStepSendEmail, FormStepSendNotificationEmail, and FormStepWebTracking.
Show Source
Nested Schema : Size
Type: object
Title: Size
Show Source
Nested Schema : permissions
Type: array
The permissions for the form field update mapping granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FormElement
Type: object
Title: FormElement
Show Source
Nested Schema : permissions
Type: array
The permissions for the form element granted to your current instance.
Show Source
Nested Schema : FormProcessingStep
Type: object
Title: FormProcessingStep
Show Source
Nested Schema : ProcessingStepCondition
Type: object
Title: ProcessingStepCondition
Show Source
Nested Schema : permissions
Type: array
The permissions for the form processing step granted to your current instance.
Show Source
Nested Schema : conditionalFieldCriteria
Type: array
The conditional field criteria for the form processing step condition.
Show Source
Nested Schema : FieldComparisonCriteria
Type: object
Title: FieldComparisonCriteria
Show Source
Nested Schema : Condition
Type: object
Title: Condition
Show Source
Nested Schema : permissions
Type: array
The permissions for the field comparison criteria granted to your current instance. This is a read-only property.
Show Source

304 Response

Not Modified. See Status Codes for information about other possible HTTP status codes.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to archive a form using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Archive the form with id#5:


POST /api/REST/2.0/assets/form/5/archive
Content-Type: application/json 
			

Request body:

In this example we are specifying in the request body a folder to move the archived form into. This is optional. If a targetFolderId is not specified, the form will be moved into the root folder.


{
  "targetFolderId": "10"
}
			

Response:


{
  "type": "Form",
  "currentStatus": "Draft",
  "id": "5",
  "createdAt": "1418404077",
  "createdBy": "5",
  "depth": "minimal",
  "folderId": "10",
  "name": "Form 01",
  "permissions": [
    "Retrieve",
    "SetSecurity",
    "Delete",
    "Update"
  ],
  "updatedAt": "1534172012",
  "updatedBy": "9",
  "archived": "true",
  "htmlName": "untitledForm-1418404075886",
  "isResponsive": "false"
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --header "Content-Type: application/json" --request POST --data '{"targetFolderId":"10"}' https://secure.p03.eloqua.com/api/rest/2.0/assets/form/5/archive
			
Back to Top