Unpublish form

Description

The method unpublishes a form. After this, the form becomes unavailable for users to fill out.

URL

Method: POST

https://example.com/api/v1.1/forms/deactivate

Request Parameters

Request body (application/json):

Parameter	Type	Example	Required	Description
token	string	a1b2c3d4e5f67890abcdef1234567890	Yes	API token
id	integer	1	Yes, if shortname is not specified	Form ID
shortname	string	form_6Ven2v7O	Yes, if id is not specified	Form short name

Request Example

JSON

{
  "token": "a1b2c3d4e5f67890abcdef1234567890",
  "id": 1
}

XML

<xml>
  <token>a1b2c3d4e5f67890abcdef1234567890</token>
  <id>1</id>
</xml>

Response Example

JSON

{
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response Parameters

Parameter	Type	Description
error	integer	Error code
error_text	string	Error text