Skip to main content

Trigger agreement

POST 
/v2/sign/agreements/:agreement_id/trigger

Trigger signing workflow of a draft agreement

Request​

Path Parameters

    agreement_id stringrequired

    Agreement id to trigger

Body

    object

Responses​

OK

Schema

    id string

    Unique identifier for the agreement.

    status AgreementStatus (string)

    Possible values: [DRAFT, IN_PROGRESS, CORRECTING, COMPLETED, CANCELED, REJECTED, EXPIRED, TEMPLATE, BULK_SEND, SCHEDULED]

    updated_date date-time
    created_date date-time

    status_detail

    object

    total int32

    Total number of actions or tasks related to the agreement.

    complete_count int32

    Number of completed actions or tasks.

    message string

    Additional status message.

    configuration

    object

    deadline int32required

    Possible values: <= 90

    Deadline for the agreement in days. Defaults to 1, must be between 0 and 90.

    deadline_reminder int32

    Possible values: <= 90

    Reminder period for the deadline in days. Defaults to 1, must be between 0 and 90.

    signing_reminder int32

    Possible values: <= 90

    Signing reminder period in days. Defaults to 0, must be between 0 and 90.

    signing_reminder_interval int32

    Possible values: <= 90

    Interval for signing reminders in days. Defaults to 0, must be between 0 and 90.

    deadline_date date-time

    Specific deadline date for the agreement.

    enable_signing_reminder boolean

    Indicates whether signing reminders are enabled. Defaults to false.

    data

    object

    order boolean

    Indicates if signing should follow a specific order.

    self_sign boolean

    Indicates if the agreement can be self-signed.

    document_name string

    Name of the document associated with the agreement.

    content string

    Content of the agreement in the default language.

    content_by_lang

    object

    Content of the agreement translated by language, stored as a key-value map.

    property name* string

    timezone

    object

    Timezone of the agreement. Defaults to GMT+07.

    ID string
    rawOffset int32
    iD string
    displayName string
    dSTSavings int32
    batch_name string

    Name of the batch if the agreement is part of a batch process.

    bulk_send boolean

    Indicates if the agreement is sent in bulk. Defaults to false.

    bulk_send_list_id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    Unique identifier for the bulk send list.

    batch_id string

    Unique identifier for the batch.

    public_view_expires_in_minutes int64

    Expiration time in minutes for public view access.

    mail_otp_expires_in_minutes int64

    Expiration time in minutes for mail OTP verification.

    require_mfa_for_signing boolean

    Indicates if multi-factor authentication is required for signing.

    participants

    object[]

    List of participants involved in the agreement.

  • Array [

    • id string

    Unique identifier for the participant.

    username string

    Username of the participant.

    email string

    Email address of the participant.

    role string

    Role of the participant in the agreement.

    order int32

    Order of the participant in the signing process.

    name string

    Full name of the participant.

    authentication_type AuthenticationType (string)

    Possible values: [PIN, NONE]

    signature_types SignatureType (string)[]

    Possible values: [ALL, DIGITAL, NORMAL]

    List of allowed signature types for the participant.

    setting_signature_type boolean

    Indicates if the participant can set their signature type. Defaults to false.

    lang string

    Preferred language of the participant.

    extra_fields

    object

    Additional fields associated with the participant as a key-value map.

    is_completed boolean

    Indicates whether the participant has completed their required actions.

    supplement_tasks

    object[]

    List of additional tasks assigned to the participant.

  • Array [

    • doc_id string

    Unique identifier for the document associated with the supplement task.

    action SupplementAction (string)

    Possible values: [NONE, VIEW, ACCEPT, VIEW_AND_ACCEPT, READ_AND_ACCEPT]

    acted boolean

    Indicates whether the action has been performed. Defaults to false.

  • ]

  • ]

    • note

    object

    id string
    content string

    owner

    object

    username string

    Username of the user.

    email string

    Email address of the user.

    name string

    Full name of the user.

    folders

    object[]

    List of folders containing the agreement.

  • Array [

    • type FolderType (string)

    Possible values: [DRAFT, COMPLETED, CANCELED, REJECTED, EXPIRED, IN_PROGRESS, ALL, INBOX, SENT, WAITING_FOR_ME, WAITING_FOR_OTHERS, EXPIRING_SOON, RECYCLE_BIN, AGREEMENT_CUSTOM_FOLDER, AGREEMENT_LABEL, AGREEMENT_BATCH, TEMPLATE_MY_TEMPLATE, TEMPLATE_ALL, TEMPLATE_SHARE_WITH_ME, TEMPLATE_FAVORITE, TEMPLATE_RECYCLE_BIN, TEMPLATE_CUSTOM_FOLDER]

    name string

    Name of the folder.

    configuration

    object

    Additional configuration for the folder as a key-value map.

    id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

  • ]

    • started_date date-time
    thumbnail string

    Thumbnail URL of the agreement.

    documents

    object[]

    List of documents associated with the agreement.

  • Array [

    • download_url string

    URL where the document can be downloaded.

    thumbnail_url string

    URL of the document's thumbnail image.

    file_name string

    Name of the file including the extension.

    size int32

    Size of the document in bytes.

    has_schema boolean

    Flag indicating whether the document is generate document

    type string

    Type of the document, default is MAIN.

    content_type string

    The content type of the document

  • ]

    • fields

    object[]

    List of fields in the document.

  • Array [

    • name string

    Name of the field.

    type string

    Type of the field (e.g., SIGNATURE, TEXT, etc.).

    required boolean

    Indicates whether the field is mandatory. Defaults to true.

    assignee string

    The user or participant assigned to this field.

    configuration

    object

    Additional configuration for the field as a key-value map.

    document_id string

    ID of the document associated with this field.

    value string

    The value of the field.

  • ]

    • signing_session_code string

    Unique code for the signing session.

Loading...