Configure Invitee Emails

The invitee receives email notifications about changes to the dossier. For example, when the invitee signs or declines the dossier. To configure what emails are being sent by CM.com you can configure the notifications field.

The following notification types are supported:

  • invite: An invite or reminder is sent to sign the dossier
  • signed: The invitee has signed the dossier
  • reviewed: The invitee has reviewed and approved the dossier
  • declined: The invitee has declined the dossier
  • completed: The dossier has been approved (by all invitees) and the invitee receives the signed document(s)

If you want to send all emails, it is recommended to not set the notifications or set its value to null. This way you will also receive emails for new notification types introduced in the future.

To skip all invitee emails provide an empty notifications array: notifications: [] or do not set the invitee email field.

Request

POST https://api.cmdisp.com/sign/v1/dossiers

Request headers

Content-Type: application/json
Authorization: Bearer GENERATED_TOKEN_HERE

Request body

{
    "name": "Purchase contract",
    "invitees": [
        {
            "name": "Invitee",
            "email": "[email protected]",
            "notifications": [
                "invite",
                "completed"
            ]
        }
    ]
}

Response

{
    "id": "302935b2-8a22-4e25-bffb-fccda8963bd4",
    "name": "Purchase contract",
    "invitees": [
        {
            "name": "Invitee",
            "email": "[email protected]",
            "notifications": [
                "invite",
                "completed"
            ]
        }
    ],
    "expiresIn": 2592000,
    "expiresAt": "2022-01-31T00:00:00+00:00",
    "createdAt": "2022-01-01T00:00:00+00:00"
}

Did this page help you?