Skip to main content

Update a Participant

PUT 
/agreements/:agreement_id/participants/:participant_id

Updates an existing participant. The agreement must be in draft status in order to update a participant. If the agreement is in open status, the exisiting participants are immutable. In the case of an open agreement, you can still add and delete participants.

Request​

Path Parameters

    agreement_id cuidrequired

    PUT /agreements/:agreement_id/participants/:participant_id parameter

    participant_id cuidrequired

    PUT /agreements/:agreement_id/participants/:participant_id parameter

Body

PUT /agreements/:agreement_id/participants/:participant_id request body

    email email

    The email of the participant. Will be used in all communication, if email communication is enabled for the agreement.

    name string

    The name of the participant. If omitted, the email adress will be used as name.

    role string

    Possible values: [signer, approver]

    The role of the participant within the signing process. If the agreement is configured for qualified signatures, only "signer" is supported. Default role is "signer".

    identity_enforcement object
    oneOf
    personal_number stringrequired

    The personal number of the participant. If provided, the signer will have to use an advanced signing method which supports swedish personal numbers to sign the agreement and only be allowed to sign if the personal number matches what is provided. Only available for signers.

    order int64

    Possible values: >= -9007199254740991 and <= 9007199254740991

    Only applicable if signing order is enabled for the agreement. It specifies the order in the signing queue this participant will have. Will be put last in line if not specified. If multiple participants share the same queue number, this participant will take precendent and the rest will be moved forward accordingly.

Responses​

PUT /agreements/:agreement_id/participants/:participant_id Successful response

Schema
    version stringrequired

    Possible values: [1.0]

    The version of the response schema

    result_type stringrequired

    Possible values: [single]

    A single object of the participant resource.

    resource_type stringrequired

    Possible values: [participant]

    Data contains the participant resource.

    data object

    The participant resource

    oneOf
    role stringrequired

    Possible values: [approver]

    The role of the participant

    decision_made_at stringnullablerequired

    UTC datetime ISO string

    id cuidrequired

    The unique identifier of the participant

    resource_type stringrequired

    Possible values: [participant]

    name stringnullablerequired

    The name of the participant. Required if no email is provided.

    email stringnullablerequired

    The email of the participant. Required if agreemnt is configured to send emails.

    status stringrequired

    Possible values: [draft, pending, initiated, processing, fulfilled, rejected]

    The status of the participant

    order doublenullablerequired

    Possible values: <= 1.7976931348623157e+308

    The queue number of the participant (if sequential signing order is enabled)

    signing_group object required
    oneOf

    string

    agreement cuidrequired

    The unique identifier for the agreement this participant belongs to

    signing_room_url urlnullablerequired

    The URL to the signing room for the participant. Only available after the agreement has been finalized for signing.

    created_at stringrequired

    UTC datetime ISO string

    updated_at stringrequired

    UTC datetime ISO string

Loading...