POST forms
Create a Form.
Resource Path
/forms
Request Body
The request body is a JSON representation of the Form being created.
Example Request
Create a form with 3 fields.
POST https://api.swiftapp.com/v1/forms
POST DATA
Response
GET forms/:id
Returns the Form with the given :id.
Resource Path
/forms/:id
Request Parameters
Name |
Type |
Description |
|---|---|---|
id |
Required |
The identifier for the desired form. |
Example Request
GET https://api.swiftapp.com/v1/forms/1234
Response
PUT forms/:id
Modify an existing form. Fields cannot be modified from this end point and can only be modified via the field endpoints.
Resource Path
/forms/:id
Request Body
The request body is a JSON representation of the Form being updated.
Example Request
Rename a form.
PUT https://api.swiftapp.com/v1/forms/1234
PUT DATA
Response
DELETE forms/:id
Delete a form.
Resource Path
/forms/:id
Request Parameters
Field |
Type |
Description |
|---|---|---|
id |
Required |
The identifier for the desired form |
Example Request
DELETE https://api.swiftapp.com/v1/forms/9999
POST forms/:id/fields
Add a new Field to a form.
Resource Path
/forms/:id/fields
Request Body
The request body is a JSON representation of the Field being added.
Request Parameters
Field |
Type |
Description |
|---|---|---|
id |
Required |
The identifier for the desired form |
Example Request
POST https://api.swiftapp.com/v1/forms/9999/fields
POST DATA
Response
PUT forms/:id/fields/:field_id
Modify a field.
Resource Path
/forms/:id/fields/:field_id
Request Body
The request body is a JSON representation of the Field being modified.
Request Parameters
Field |
Type |
Description |
|---|---|---|
id |
Required |
The numerical id of the desired form |
field_id |
Required |
Account id of the field |
Example Request
Below request makes a previously optional field, mandatory.
PUT https://api.swiftapp.com/v1/forms/9999/fields/4321
PUT DATA
Response
DELETE forms/:id/fields/:field_id
Remove an existing account field. Only form owners can perform this action.
Resource Path
/forms/:id/fields/:field_id
Request Parameters
Field |
Type |
Description |
|---|---|---|
id |
Required |
Identified for the the desired form. |
field_id |
Required |
Identified for the field. |
Example Request
DELETE https://api.swiftapp.com/v1/forms/9999/fields/345