Introduction
First of all, let's have a look at some technical terms that will be used throughout the process of a request creation.
A Request is a collecting process (endpoint: /tenants/{tenant_id}/works/{work_id}/requests) to retrieve information from a Recipient (endpoint: /tenants/{tenant_id}/works/{work_id}/recipients). A Request is stored inside a Rork (endpoint: /tenants/{tenant_id}/{works}), which is itself stored inside a Tenant (endpoint: /tenants).
Here is the classic process of a Request in Paprwork :
- Create a Tenant (or retrieve an existing Tenant's ID)
- Create a Work (or retrieve an existing Work's ID, inside the Tenant) that will contain your Request
- Create a Recipient (or retrieve an existing Recipient's ID, inside the Work) that will receive your Request
- No account on Paprwork is necessary for the Recipient to complete the Request
- Each Recipient is scope to a Work, it means that if you have to send several Requests (from several Works), you have to create a recipient with the same email address for each Requests' Work.
- Create the Request
- An email is sent to the Recipient and invites it to complete the Request.
- Once the Recipient has completed the Request, the Request is marked as finished