Skip to main content

Bulk send agreement from template

POST 
/v2/agreement-batches/bulk-send

Bulk send agreement from template

Request​

Body

    template_id stringrequired

    Id of template to create agreement from

    trigger

    object

    trigger boolean
    batch_name string

    Batch name

    participant_mappings

    object[]

  • Array [

    • template_participant_ref stringrequired

    Reference to participant that defined in template

    data_participant_alias_ref stringrequired

    Uniquely references the generated document data

  • ]

    • items

    object[]

    required

    Bulk send items data

  • Array [

    • participants

    object[]

    required

    Participant info

  • Array [

    • template_participant_ref stringrequired

    Reference to participant that defined in template

    name stringrequired

    Participant name

    email stringrequired

    Participant email

    client_user_id string

    Unique id of participant in client application

  • ]

    • document_generation_data

    object

    fields

    object

    property name* string

  • ]

Responses​

OK

Schema

    batch_id string

    Batch id

Loading...