Skip to main content

Update an Agreement

PUT 
/agreements/:agreement_id

Updates an agreement. The agreement must be in draft or open status.

Request​

Path Parameters

    agreement_id cuidrequired

    PUT /agreements/:agreement_id parameter

Body

PUT /agreements/:agreement_id request body

    issuer object

    The issuer of the agreement. If not provided, the authenticated client will be used.

    name string

    The name of the issuer

    email string

    The email of the issuer. Will be used for communication if email communication is enabled for the agreement.

    role string

    Possible values: [observer, signer, approver]

    The role of the issuer within the signing process.

    send_emails boolean

    Enables email communication in the agreement process. If not provided, the default value is true. If disabled, you will be responsible for handling all communication.

    trust_level string

    Possible values: [SES, AES, QES]

    The minimum trust level used for all signatures in accordance with the eIDAS regulation. If not provided, the default value is SES.

    signing_order boolean

    Enables signing order for the agreement process. If not provided, the default value is false. If enabled, the signers will be required to sign in the order in which they are defined.

    theme object
    oneOf
    id cuidrequired

    The ID of the theme to use for the agreement.

    success_callback_url object
    oneOf

    string

    default_locale string

    Possible values: [sv-SE, en-US]

    Default value: sv-SE

    The default locale of the signing process. Can be overridden by individual participants, but the default locale determines the primary language used in all communication and UI.

    lookup_key object
    oneOf

    string

Responses​

PUT /agreements/:agreement_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 agreement resource.

    resource_type stringrequired

    Possible values: [agreement]

    Data contains the agreement resource.

    data objectrequired

    The resource data.

    id cuidrequired

    The unique identifier of the agreement

    resource_type stringrequired

    Possible values: [agreement]

    test_mode booleanrequired

    Indicates if the agreement is created using a development client

    status stringrequired

    Possible values: [draft, pending, fulfilled, cancelled, generating, failed_to_generate, open]

    The status of the agreement

    trust_level string

    Possible values: [SES, AES, QES]

    The minimum trust level for the signatures.

    cancellation_reason stringnullablerequired

    If the agreement is in a cancelled state, this will be a short description on the reason why, otherwise it will be null.

    theme object required
    oneOf

    string

    issuer objectrequired

    The issuer of the agreement

    name stringnullablerequired

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

    email stringnullablerequired

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

    role stringrequired

    Possible values: [signer, approver, observer]

    The role of the issuer in the agreement process.

    participant_id cuid

    If the issuer is a signer or approver this is the ID of the related participant.

    signing_room_url urlnullablerequired

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

    participants object required
    oneOf
  • Array [

    • string

  • ]
    • observers object
    oneOf
  • Array [

    • string

  • ]
    • signing_groups object
    oneOf
  • Array [

    • string

  • ]
    • documents object
    original_documents objectrequired
    main object required

    The main document which will be signed.

    oneOf

    string

    attachments object
    oneOf
  • Array [

    • string

  • ]
    • signed_document object required

    The finalized and signed document.

    oneOf

    string

    signing_order objectrequired
    enabled booleanrequired
    grouped booleanrequired
    communication objectrequired
    send_emails booleanrequired
    default_locale string

    Possible values: [sv-SE, en-US]

    metadata object
    lookup_key string

    A provided lookup key provided by you to help you identify the agreement.

    success_callback_url url

    A provided callback url to refer the participants back to post successful action.

    updated_at stringrequired

    UTC datetime ISO string

    created_at stringrequired

    UTC datetime ISO string

Loading...