Update dossier

put

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

Modify a single dossier and its related information

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

dossierId

uuid

required

a uuid string that identifies a dossier

Body Params

uuid

Id of the dossier

name

string

required

length ≤ 255

human readable name for this dossier

state

string

enum

Every dossier is initialized with the draft state. When the dossier is pending, it will have sent out any invitations for signing. From this point, the dossier is mostly no longer editable. Once the everyone has signed, the state becomes completed and the signed dossier will be ready for retrieval. If any invitee declines the state of the dossier will become delinced. After the dossier expiry time has passed, a dossier will always enter the expired state. In the expired state a dossier can no longer be completed or declined. Once the state is deleted the signed contracts are no longer downloadable and all contracts and sensitive information are removed from the system.

Allowed:

locale

string

enum

Defaults to en-US

Locale of the language to be used in the dossier

prepare

boolean | null

Place fields using the web interface

prepareReturnUrl

string | null

Optionally redirect the user to your website after the fields are placed. The url must begin with https://

timezone

string | null

The identifier of a time zone in the IANA database. This will change the time zone of dates used in communication to the recipient and dossier owner. By default Etc/UTC is used when no value is set.

expiresIn

number

60 to 7776000

Defaults to 2592000

The expiry in seconds since the dossier was created

reminderIn

number | null

86400 to 7776000

The time in seconds after the invite was sent to an invitee, after which an automatic reminder will be sent. Reminders only work if the invite emails were sent by Sign. To cancel all reminders for an existing dossier set value to null

owners

array of objects

owners

files

array of objects

files

invitees

array of objects

invitees

attachments

array of objects

attachments

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.