Update invitee

put

https://api.cm.com/sign/v1/dossiers/{dossierId}/invitees/{inviteeId}

Modify a single invitee and its related information.
When the dossier is in pending state only the name, email and phoneNumber can be modified.
Existing invites for the invitee are automatically invalidated if the email or phoneNumber is changed.

Path Params

dossierId

uuid

required

a uuid string that identifies a dossier

inviteeId

uuid

required

a uuid string that identifies a single invitee

Body Params

uuid

required

Optional. Indicates that only a particular invitee is allowed/required to use a field.

name

string

required

length ≤ 255

Name of the person invited to read and/or sign the document

string

length ≤ 255

A valid email address

locale

string | null

enum

Defaults to en-US

Locale of the language to be used in invitations.

position

integer

Set the order of signing. For example if there are two invitees set position 1 for the first invitee and position 2 for the second invitee. It is possible to set multiple invitees on the same position. Make sure there is no gap between the positions.

authenticationMethods

array of strings

authenticationMethods

identificationMethod

string

enum

deprecated

Additional user identification is required. When you select qualified it cannot be used with other identification methods. Please note that this is only available when configured for your account.

Allowed:

identificationMethods

array of strings

identificationMethods

notifications

array of strings or null

notifications

payments

array of objects

Additional payment is required. Please note that this is only available when configured for your account.

payments

phoneNumber

string

The phone number of the invitee in E.164 format. Required when identificationMethod is otp.

reference

string

length ≤ 255

A reference to an external identifier of your invitee.

readOnly

boolean

Defaults to false

Indicates that this invitee needs to review the dossier, instead of signing it

state

string

enum

The invitee has approved or declined the dossier

Allowed:

redirectUrl

url | null

Defaults to null

URL to redirect the invitee to after signing, approving or declining the dossier. If not set, the default confirmation page will be shown.

fields

array of objects

fields

Responses

200

401Unauthorized

404The specified resource was not found

422The request cannot be made because the state of the dossier does not match the state that is expected for this operation.