Collect API documentation

Add an element

POST /elements

This endpoint allows you to add an element to an existing request. You can currently add docs, text and pages. form will come later.

application/json

Body object

requestId string Required
type string Required

Type of the element. Can be docs, text and pages.

Values are docs, text, or pages.
name string

Name of the element.
order integer

Order of the element on the portal. Order should be an integer and starts at 0.

Minimum value is 0.
description string

Description of the document that needs to be uploaded.
nickname string

A nickname for this element. Can be useful to classify your uploaded docs.
path string

A path for this element. Can be useful to classify your uploaded docs.
mandatory boolean

Is the document mandatory or not. Default is true.
extensions array[string]

A list of document extensions that are accepted. By default, all type of documents are accepted. Must be formated as a string like ['xls','xslx'].
multipleupload boolean

Specify if you are accepting multi documents for the same element. Default is true.

requestId string Required
type string Required

Type of the element. Can be docs, text and pages.

Values are docs, text, or pages.
name string

Name of the text block. This name is not displayed on the portal, it's only used in your own interface. Default is Text block.

Default value is Text block.
order integer

Order of the element on the portal. Order should be an integer and starts at 0.

Minimum value is 0.
text string

A string containing the HTML that you want to display.

requestId string Required
type string Required

Type of the element. Can be docs, text and pages.

Values are docs, text, or pages.
name string

Name of the page.

Default value is New page.
order integer

Order of the element on the portal. Order should be an integer and starts at 0.

Minimum value is 0.

Responses

• 200 application/json
One of:
Document object Form object Sign object Text object Page object
Hide attributes Show attributes

id string

Element ID

itemId string

Reference of the element in the campaign

name string

Element name

order integer

Element order

status string

Element status

mandatory boolean

Whether element is mandatory

multipleupload boolean

Whether multiple uploads are allowed

uploads array[object]

Hide uploads attributes Show uploads attributes object

createdAt string(date-time)

Timestamp of when the upload was created

name string

Upload name

url string

Upload URL

size integer

Upload size

type string

Element type

request object

Hide request attributes Show request attributes

_id string

Request ID

campaignId string

Campaign ID
Hide attributes Show attributes

id string

Element ID

itemId string

Reference of the element in the campaign

name string

Element name

order integer

Element order

status string

Element status

items array[object]

All the fields of the form

Hide items attributes Show items attributes object

name string

Name of the field

type string

Type of field

answer string

Value if there is an answer

type string

Element type

request object

Hide request attributes Show request attributes

_id string

Request ID

campaignId string

Campaign ID
Hide attributes Show attributes

id string

Element ID

itemId string

Reference of the element in the campaign

name string

Element name

order integer

Element order

status string

Element status

uploads array[object]

Hide uploads attributes Show uploads attributes object

createdAt string(date-time)

Timestamp of when the upload was created

name string

Upload name

url string

Upload URL

size integer

Upload size

type string

Element type

request object

Hide request attributes Show request attributes

_id string

Request ID

campaignId string

Campaign ID
Hide attributes Show attributes

id string

Element ID

itemId string

Reference of the element in the campaign

name string

Element name

order integer

Element order

text string

A string containing the HTML that will be displayed on the portal.

type string

Element type

request object

Hide request attributes Show request attributes

_id string

Request ID

campaignId string

Campaign ID
Hide attributes Show attributes

id string

Element ID

itemId string

Reference of the element in the campaign

name string

Element name

order integer

Element order

type string

Element type

request object

Hide request attributes Show request attributes

_id string

Request ID

campaignId string

Campaign ID
• 400

Bad Request -- Your request is invalid.
• 401

Unauthorized -- Your API key is wrong.
• 403

Forbidden -- The object requested is hidden for administrators only.
• 404

Not Found -- The specified object could not be found.
• 429

Too Many Requests -- You're requesting too many objects! Slow down!
• 500

Internal Server Error -- We had a problem with our server. Try again later.
• 503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

POST /elements

curl \
 -X POST https://api.usecollect.com/v1/elements \
 --user "username:password" \
 -H "Content-Type: application/json" \
 -d '{"requestId":"bbbBkrejSaJkHWwDE","type":"docs","name":"ID","order":3}'

Request examples

{
  "requestId": "bbbBkrejSaJkHWwDE",
  "type": "docs",
  "name": "ID",
  "order": 3
}

{
  "requestId": "GTonevwqoPPJ2PYEy",
  "type": "text",
  "order": 4,
  "text": "Hello World!"
}

{
  "requestId": "GTonevwqoPPJ2PYEy",
  "type": "page",
  "order": 2,
  "name": "More details"
}

Response examples (200)

{
  "id": "eEDJFD5unNQTHoSBZ",
  "itemId": "urRJfPK7CfyGBnHg8",
  "name": "ID",
  "order": 3,
  "visibility": true,
  "status": "open",
  "mandatory": true,
  "multipleupload": true,
  "uploads": [],
  "type": "docs",
  "request": {
    "_id": "bbbBkrejSaJkHWwDE",
    "campaignId": "7gDq3XyLyixkhqoHa"
  }
}

{
  "id": "BKJ95xmpHSyo7KuRC",
  "itemId": "7LBBC8LwnBnQoz8ae",
  "name": "Text block",
  "order": 4,
  "visibility": true,
  "type": "text",
  "text": "Hello World!",
  "request": {
    "_id": "GTonevwqoPPJ2PYEy",
    "campaignId": "3ya2sjN9GYwYAHeSi"
  }
}

{
  "id": "XigRzPs4N5vwX3Rks",
  "itemId": "L3uAmzDRJjWTm2TMR",
  "name": "More details",
  "order": 2,
  "visibility": true,
  "type": "page",
  "request": {
    "_id": "GTonevwqoPPJ2PYEy",
    "campaignId": "3ya2sjN9GYwYAHeSi"
  }
}