RequestItems

Create Request Item

Create new request item associated with specified request.

post/requests/{request_id}/items

Request

  • Base URL: https://api.pigeondocuments.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.pigeondocuments.com/requests/{request_id}/items
  • Auth: none declared

Path parameters

request_idstring required

Request body

namestring required

Item name. For items with type: Question, the name is used as the question text.

type'UPLOAD' | 'E_SIGNATURE' | 'QUESTION' required
descriptionstring

Item description

requiredboolean

Indicates whether the recipient is required to complete the request item. Defaults to true.

receivedboolean

If true, request item will appear as completed in request checklist.

Response

Successful Response

namestring required

Item name. For items with type: Question, the name is used as the question text.

idstring required
type'UPLOAD' | 'E_SIGNATURE' | 'QUESTION' required
descriptionstring

Item description

requiredboolean

Indicates whether the recipient is required to complete the request item. Defaults to true.

answerstring

Question answer. Only applies to items with type: QUESTION

verifiedboolean

Indicates whether the request item has been verified by the recipient

is_naboolean

Indicates whether the request item is not applicable

Changes

No recorded changes to this operation across all 1 revision of this API.