Skip to content
Legaldoc.ioLegaldoc.ioLegaldoc.io

Distribute envelope

POST
/envelope/distribute
curl --request POST \
  --url https://app.legaldoc.com/api/v2/envelope/distribute \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "envelopeId": "example", "meta": { "subject": "example", "message": "example", "timezone": "example", "dateFormat": "yyyy-MM-dd hh:mm a", "distributionMethod": "EMAIL", "redirectUrl": "example", "language": "de", "emailId": "example", "emailReplyTo": "example", "emailSettings": { "recipientSigningRequest": true, "recipientRemoved": true, "recipientSigned": true, "documentPending": true, "documentCompleted": true, "documentDeleted": true, "ownerDocumentCompleted": true, "ownerRecipientExpired": true, "ownerDocumentCreated": true } } }'

Send the envelope to recipients based on your distribution method

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
envelopeId
required
string
meta
object
subject
string
<= 254 characters
message
string
<= 5000 characters
timezone
string
dateFormat
string
Allowed values: yyyy-MM-dd hh:mm a yyyy-MM-dd dd/MM/yyyy dd-MM-yyyy MM/dd/yyyy yy-MM-dd MMMM dd, yyyy EEEE, MMMM dd, yyyy dd/MM/yyyy hh:mm a dd/MM/yyyy HH:mm dd-MM-yyyy hh:mm a dd-MM-yyyy HH:mm MM/dd/yyyy hh:mm a MM/dd/yyyy HH:mm dd.MM.yyyy dd.MM.yyyy HH:mm yyyy-MM-dd HH:mm yy-MM-dd hh:mm a yy-MM-dd HH:mm yyyy-MM-dd HH:mm:ss MMMM dd, yyyy hh:mm a MMMM dd, yyyy HH:mm EEEE, MMMM dd, yyyy hh:mm a EEEE, MMMM dd, yyyy HH:mm yyyy-MM-dd'T'HH:mm:ss.SSSXXX
distributionMethod
string
Allowed values: EMAIL NONE
redirectUrl
string
language
string
Allowed values: de en fr es it nl pl pt-BR ja ko zh
emailId
string | null
emailReplyTo
string | null
/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~\u{0080}-\u{FFFF}-]+@[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?(?:\.[a-zA-Z0-9\u{0080}-\u{FFFF}](?:[a-zA-Z0-9\u{0080}-\u{FFFF}-]{0,61}[a-zA-Z0-9\u{0080}-\u{FFFF}])?)*$/
emailSettings
object
recipientSigningRequest
boolean
default: true
recipientRemoved
boolean
default: true
recipientSigned
boolean
default: true
documentPending
boolean
default: true
documentCompleted
boolean
default: true
documentDeleted
boolean
default: true
ownerDocumentCompleted
boolean
default: true
ownerRecipientExpired
boolean
default: true
ownerDocumentCreated
boolean
default: true

Responses

Section titled “Responses”

200

Section titled “200”

Successful response

Media typeapplication/json
object
success
required
boolean
id
required
string
recipients
required
Array<object>
object
id
required
number
name
required
string
email
required
string
token
required
string
role
required
string
Allowed values: CC SIGNER VIEWER APPROVER ASSISTANT
signingOrder
required
number | null
signingUrl
required
string
Example
{
  "recipients": [
    {
      "role": "CC"
    }
  ]
}

400

Section titled “400”

Invalid input data

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

401

Section titled “401”

Authorization not provided

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

403

Section titled “403”

Insufficient access

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal server error

Media typeapplication/json
object
message
required
string
code
required
string
issues
Array<object>
object
message
required
string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "issues": [
    {
      "message": "example"
    }
  ]
}