POST /requests

{{base-api-url}}/tenants/TENANT_ID/works/WORK_ID/requests

Headers#

Name	Content
Authorization	{{your-api-key}}
Content-Type	application/json

Body#

{
    "name": "My new Request",
    "description": "My new Request's description",
    "deadline": "2021-06-28T22:00:00.000Z",
    "recipientId": "X",
    "items": [
        {
            "name": "My information",
            "type": "MESSAGE"
        },
        {
            "name": "My choice",
            "type": "PROMPT",
            "promptChoices": [
                {
                    "choice": "Choice 1"
                },
                {
                    "choice": "Choice 2"
                }
            ]
        }
    ]
}

Example request#

curl --location -g --request POST '{{base-api-url}}/tenants/TENANT_ID/works/WORK_ID/recipients' \
--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"
    },
    ]
}'

Example response#

{
    "request": {
        "id": "X",
        "slug": "my-new-request",
        "name": "My new Request",
        "description": "My new Request's description",
        "status": "ONGOING",
        "deadline": "2021-06-28T22:00:00+00:00",
        "lastReminderDate": null,
        "emailStatus": "UNKNOWN",
        "readAt": null,
        "createdAt": "2021-06-21T10:49:58+00:00",
        "author": {
            "firstName": "John",
            "lastName": "Doe",
            "avatarUrl": "http://my-avatar-url.com"
        },
        "recipient": {
            "id": "X",
            "firstName": "Tim",
            "lastName": "Cook",
            "email": "tim@cook.com",
            "role": null
        },
        "documents": [],
        "requestComments": {
            "edges": []
        },
        "items": [
            {
                "name": "Date of birth",
                "description": null,
                "type": "MESSAGE",
                "id": "X",
                "document": null,
                "answer": null
            },
            {
                "name": "ID card",
                "description": null,
                "type": "DOCUMENT",
                "id": "X",
                "document": null,
                "answer": null
            },
            {
                "name": "What colour do you prefer ?",
                "description": null,
                "type": "PROMPT",
                "id": "X",
                "message": null,
                "document": null,
                "choices": [
                    {
                        "id": X,
                        "choice": "Blue"
                    },
                    {
                        "id": X,
                        "choice": "Red"
                    }
                ],
                "answer": null
            },
            {
                "name": "Read receipt",
                "description": null,
                "type": "ACKNOWLEDGE",
                "document": null,
                "id": "X",
                "message": "I hereby certify that I have read this request",
                "answer": null
            }
        ]
    }
}