Create a Request

Parameters#

Name	Description
name (string) required*	The Request's name
description (string) optional	The Request's description
deadline (string) optional	The Request's deadline
documents (File) optional	The Request's attachments
items (RequestItem) required*	The Request's items

Request#

POST /tenants/:tenant_id/works/:work_id/requests

curl --location -g --request POST '/{{base-api-url}}/tenants/:tenant_id/works/:work_id/requests' \
     --header 'Authorization: Bearer {{your-api-key}}' \
     --header 'Content-Type: application/json' \
     --data-raw '{
       {
         "name": "My new Request",
         "description": "My new Request\'s description",
         "deadline": "2021-06-28T22:00:00.000Z",
         "recipientId": "X",
         "items": [
           {
             "name": "Date of birth",
             "type": "MESSAGE"
           },
           {
             "name": "ID card",
             "type": "DOCUMENT"
           },
           {
             "name": "What colour do you prefer ?",
             "type": "PROMPT",
             "promptChoices": [
               {
                 "choice": "Blue"
               },
               {
                 "choice": "Red"
               }
             ]
           },
           {
            "name": "Read receipt",
            "type": "ACKNOWLEDGE",
            "message": "I hereby certify that I have read this request"
           }
         ]
       }
     }'

Returns#

Returns a Request object if creation succeeded.

Returns an error otherwise.