Create a Request

post

https://api.pactsafe.com/v1.1/sites/{site_id}/requests

Path Params

site_id

int32

required

The ID (number) of the Site you're creating a Request in.

Body Params

name

string

The name of the Request. We generally recommending ensure a name exists on a Request for more simple referencing within the PactSafe web app.

description

string

The description of the request.

subject

string

The subject line as part of the email sent when notifications are enabled.

message

string

The message included within the email.

contracts

array of int32s

The IDs of contracts that need to be sent as part of the request. Before sending the request, ensure your contracts are published.

contracts

signers

array of objects

The signers that will be a part of the Request.

signers

allow_comments

boolean

Requires "Comment mode" to be enabled within your account. Will allow signers and recipients to add comments to the contracts in your Request.

signing_order

boolean

Will enable signing order (requires an "order" parameter as specified in the "signers" object).

force_scroll

boolean

Will force a Signer to scroll to the bottom of the Request before the "Agree" button is displayed.

smartpact

boolean

Will set the Request to be a SmartPact. More info on SmartPacts can be found here

automated_request_reminders

boolean

Defaults to true

Whether to automatically notify the signer to sign the Request.

redirect_url

string

URL to redirect the signer to after signing.

expiration_time

string

Set a time for the request to expire in ISO8601 timestamp format. (e.g., 2013-02-04T22:44:30.652Z)

expiration_message

string

An optional message regarding the expiration. Limit of 500 characters.

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400