latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Subscriptions

Put Subscriptions

Subscribe or edit the list of email addresses that receive the notifications. Currently, the following types of events are available for subscription:

Data Upload Completed: Receive a notification when an upload of data for the project is completed, including information if any errors were found. The email is only sent after the asynchronous part of the upload is finished. Note that you will receive an email per each input unit set uploaded. You can know more in <a href="#tag/Input-Units">data upload section</a>.

Deliverable Published: Receive a notification when a new result file for the project is available to download. You can know more in the <a href="#tag/Deliverables">deliverables section</a>.

Permissions: Update Project Properties

put/v2.0/public/projects/{projectId}/subscriptions

Path parameters

projectIdstring uuid required

Example:00000000-0000-0000-0000-000000000000

Project ID.

Request body

typestring required

Type of notifications. Valid values: "DeliverablePublished" and "DataUploadCompleted".

tostring[] required

List of main recipients of the email addresses [1-10].

emailListConsentboolean required

By setting this flag to True the user acknowledges that it has obtained all necessary valid consents from the relevant data subjects (email owners) to subscribe, on their behalf, each respective email address to this notification service, in compliance with the applicable data protection laws, and in agreement with Defined.ai's service <a href="https://www.defined.ai/terms-of-use">Terms of Use</a> and <a href="https://www.defined.ai/privacy-policy">Privacy Policy</a>.

Response

Accepted. Subscription will be configured asynchronously.