Trigger e-signature

POST /trigger-sign

This endpoint triggers the e-signature process for a document. Once triggered, the status will change from "not-sent" to "sent" and no further modifications will be accepted.

application/json

Body Required

  • elementId string Required

    ID of the e-sign element you want to trigger the signature for

Responses

  • 200 application/json

    Successfully triggered e-signature process

    Hide response attributes Show response attributes object
    • id string

      Element ID

    • itemId string

      Reference of the element in the campaign

    • name string

      Element name

    • order integer

      Element order

    • visibility boolean

      Visibility of the element on the portal

    • visibilityConditionnal boolean

      Whether the visibility is conditional

    • status string

      Status of the signature element

      Values are not-sent, sent, signed, or rejected.

    • type string

      Element type

      Value is sign.

    • request object

      Additional properties are allowed.

      Hide request attributes Show request attributes object
  • 400

    Bad Request -- Your request is invalid.

  • 401

    Unauthorized -- Your API key is wrong.

  • 403

    Forbidden -- The object requested is hidden for administrators only.

  • 404

    Not Found -- The specified object could not be found.

  • 429

    Too Many Requests -- You're requesting too many objects! Slow down!

  • 500

    Internal Server Error -- We had a problem with our server. Try again later.

  • 503

    Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

POST /trigger-sign 
curl \
 --request POST https://api.usecollect.com/v1/trigger-sign \
 --header "Content-Type: application/json" \
 --data '{"elementId":"JfcGWum37pXtd2Bsq"}'
Request example 
{
  "elementId": "JfcGWum37pXtd2Bsq"
}
Response examples (200) 
{
  "id": "JfcGWum37pXtd2Bsq",
  "name": "Partnership Agreement with ACME Corp",
  "type": "sign",
  "order": 0,
  "itemId": "a3qRLd684bWLt3a5s",
  "status": "sent",
  "request": {
    "_id": "SP2DvMdB98mPB264c",
    "campaignId": "SXwNhaTXzcjoYx9Ea"
  },
  "visibility": true,
  "visibilityConditionnal": true
}