Create Field on a Version

post

https://api.pactsafe.com/v1.1/versions/{version_id}/fields

Create a field to a Version. Note: the Version must be in a draft state.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

version_id

string

required

The unique ID of the Contract Version.

Body Params

name

string

required

The name of the field.

label

string

The label of the field.

type

string

enum

required

Defaults to text

The type of field.

required

boolean

Defaults to false

Whether the field is required to be filled prior to acceptance.

assignment_value

string

enum

required

Defaults to signer

Whether the field is assigned to the Sender or the Signer.

Allowed:

persona

string

The Signer Role to use when creating the field.

default_value

string

A default value that can be applied to the field.

read_only

boolean

Defaults to false

Whether field field can be changed or not. This is typically only used in scenarios where the field has a default value.

Responses

Language

Credentials

OAuth2

Loading…

Response

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

application/json

200200

400400