Skip to main content

Update Lifecycle State

POST 
/agreements/:agreement_id/lifecycle

Update the lifecycle status of an agreement: pending, open or cancelled.

Pending: When an agreement is switched to Pending, it is finalized for signing by validating all inputs and, if communication is enabled, sends out all or the first batch of invitations. A Pending agreement can be either cancelled or opened.

Open: If the agreement is opened, the signing process is paused and reset to allow making any changes you would like to do.

Cancelled: If you cancel the agreement, it is moved into an end state where no more changes are allowed. If communication is enabled and the agreement is cancelled, notifications will be sent to all participants.

Request​

Path Parameters

    agreement_id cuidrequired

    POST /agreements/:agreement_id/lifecycle parameter

Body

POST /agreements/:agreement_id/lifecycle request body

    lifecycle_state object required

    The lifecycle state of the agreement

    oneOf
    status stringrequired

    Possible values: [cancelled]

    input object required
    oneOf
    cancellation_type stringrequired

    Possible values: [invalid_document, invalid_participant, invalid_email]

Responses​

POST /agreements/:agreement_id/lifecycle 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

    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

  • ]
    • 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 object
    oneOf

    string

    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...