POST/v1/envelopes/

Create an envelope from text

This endpoint creates an envelope by passing in the actual text of the document and a list of the parties. Its useful if you already have the text of a contract prepared and simply want to use Magistrate to obtain the signatures.

Request body

Name
name
Type
string
required
Description
The name of the envelope. Limited to 254 characters that are alphanumeric, spaces, numbers, or symbols.
Name
documents
Type
list of objects
required
Description
This endpoint currently only supports one document in an envelope, so you must pass exactly 1 object in this list.
Envelopes created via this endpoint do not support custom signature blocks. Signature blocks are generated automatically from the parties and placed at the end of the document body. The signature blocks are formatted in the manner prescribed by the Manual of Style for Contract Drafting, 4th Ed.
Document Object
Name
body
Type
string
required
Description
This is the body (text) of the contract. It should not include any signature blocks.
Name
parties
Type
list of objects
required
Description
A list of the parties to the contract. Minimum length of 1. The parties should be objects with the following keys:
Party Object
Name
name
Type
string
required
Description
The legal name of the party. For example, "Magistrate Inc." if the party is an entity. Or "Harry Khanna" if the party is a human being. Limited to 80 characters.
Name
email
Type
string
required
Description
The email address of the party. If the party is an entity like a corporation, this should be the email address of the authorized signatory. Limited to 254 characters.
Name
is_entity
Type
boolean
required
Description
If the party to the contract is an entity like a corporation, this should be true. If the party is a human being, this should be false.
Name
authorized_human
Type
object
required sometimes
Description
The human being that is authorized to sign for the entity. Required if is_entity is true. Ignored if is_entity is false.
Authorized Human Object Expand
Name
webhook_url
Type
string
Description
The URL where Magistrate will POST webhooks related to this envelope. If this is provided, the API will immediately POST a webhook of type webhook_url_verification to the endpoint, and if it does not return a 2xx response within a couple seconds, the whole API call fail with a 400 response.
Name
autosign
Type
boolean
Description
If autosign is true, any signatures belonging to the creator of the envelope will be signed automatically. The creator will not receive an email soliciting their signature since they will have already signed.
This is ignored if the action is draft. This is also ignored if the creator of the envelope is not also a signatory.
Name
suppress_emails
Type
string
Description
If provided, it must be the string creator. If this is provided, the creator of the envelope will not receive any emails related to the envelope.
Name
action
Type
string
required
Description
One of the following strings: send or draft.
send will generate an envelope and send it for signature to all parties in one step.
draft will generate an envelope and save it as a draft. To make any edits or send it for signature, you must log into the web user interface.

Request

POST

/v1/envelopes/

curl "https://api.getmagistrate.com/v1/envelopes/" \
  -H "Authorization: Token d0b0b4628e184832b1b0bc1e93fbd487" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example Contract",
    "documents": [
      {
        "body": "EXAMPLE CONTRACT\n\nThis is an example of a contract."
      }
    ],
    "parties": [
      {
        "name": "Harry Khanna",
        "email": "harry@getmagistrate.com",
        "is_entity": false
      },
      {
        "name": "Smith LLC",
        "email": "jane@example.com",
        "is_entity": true,
        "authorized_human": {
          "name": "Jane Smith",
          "title": "Chief Executive Officer"
        }
      }
    ],
    "action": "send"
  }'

Response

If the request is successful, the endpoint will return a status code of 201 Created.

The response body will be the new envelope object.