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

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

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

The invitee has approved or declined the dossier

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

Show Deprecated

Responses

Response body

object

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

Defaults to en-US

Locale of the language to be used in invitations.

de-DE en-US es-ES fr-FR hu-HU it-IT ja-JP nl-NL pl-PL pt-PT ro-RO sk-SK

position

integer

authenticationMethods

array of strings

authenticationMethods

identificationMethod

string

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.

idin iban otp_sms otp_email otp_whatsapp otp_voice qualified

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

object

amount

integer

required

≥ 1

The payment amount in cents

currency

string

required

The payment currency

EUR

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

The invitee has approved or declined the dossier

approved declined

stateComment

string | null

Defaults to null

When the invitee declined the dossier this field may contain the reason for declining.

stateChanged

date-time | null

Defaults to null

The date the invitee state has changed

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

object

uuid

required

Unique Id of a field

type

string

required

The type of field for the invitee.

signature signatureDate initials text textarea label checkbox radio stamp

required

boolean

Indicates if the field is required and must be filled in by the user. When required is true and type is checkbox the field must be checked.

file

uuid

required

A unique reference number for this file.

tag

string

length ≤ 64

The tag acts as a placeholder; the range and locations of the field are automatically determined based on the location(s) of the tag in the document. Add the tag to every page the field should include in case of initials. The tag should be hidden, for example by making it white.

tagRequired

boolean

Defaults to true

Indicates if the tag must be present in the document. When this is set to false and the tag is not found in the document it will skip this field.

locations

array of objects

locations

object

range

string

length ≤ 64

The page number within the PDF that this field occupies (e.g. 1), or range for a initials field (e.g. 1-3).

float

X position of the field in points.

float

Y position of the field in points.

width

float

Width of the field in points.

height

float

Height of the field in points.

invitee

uuid

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

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
11
1
curl --request PUT \
2
     --url https://api.cm.com/sign/v1/dossiers/dossierId/invitees/inviteeId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "locale": "en-US",
8
  "readOnly": false,
9
  "redirectUrl": null
10
}
11
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

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.