Defining roles

[1stdev]

I need to send a library template. How can I define the roles (Particpiant1, Participant2... etc) for the signer. I try something whats below but  I get invalid role error:

{

  "documentCreationInfo": {

    "name": "MyTest",

    "signatureType": "ESIGN",

    "recipients": [

      {

        "fax": "",

        "email": "test@test.com",

        "role": "Participant1"

      }

    ],

    "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

    "message": "",

    "mergeFieldInfo": [

      {

        "fieldName": "Name1",

        "defaultValue": "Test Test"

      }

    ],

    "fileInfos": [

      {

        "libraryDocumentName": "TEST"

      }

    ]

  }

}

[atsmusz]

Role is for "SIGNER" or "APPROVER".

The recipient order is just the order each recipient appears in the list top to bottom.

  "recipients": [

      {

        "fax": "",

        "email": "test@test.com",

        "role": "SIGNER"

      }

{

        "fax": "",

        "email": "test2@test.com",

        "role": "APPROVER"

      }

    ],

[atsmusz · Accepted solution]

You should actually not include the fax piece.

Example:

POST /api/rest/v2/agreements HTTP/1.1

Host: secure.echosign.com

Access-Token: undefined

x-user-email: atsdyn@gmail.com

Content-Type: application/json

Cache-Control: no-cache

Postman-Token: 88d7d0a6-30f9-5a65-82df-4eb013a18ad4

{

  "documentCreationInfo": {

  "fileInfos": [

  {

  "libraryDocumentId": "2AAABLblqZhBBqN2EJssYmYSPWYDBC0X4R_Qs02L3pqjd68mdzC3V4KTOYMsmvxaQ_XukmXpuIHg*"

  }

  ],

  "message": "Please sign this agreement.",

  "name": "Test Agreement",

  "recipients": [

  {

  "email": "echosmusz1@gmail.com",

  "role": "SIGNER"

  },

  {

  "email": "echosmusz2@gmail.com",

  "role": "SIGNER"

  }

  ],

  "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

  "signatureType": "ESIGN",

  "authoringRequested": false

  }

}