Create Field on a Version

post

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

Note: the Version must be in a draft state.

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

The type of field.

required

boolean

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

default_value

string

A default value that can be applied to the field.

assignment_value

string

enum

required

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

Allowed:

read_only

boolean

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

persona

string

The Signer Role to use when creating the field.

is_trigger

boolean

trigger_field

string

trigger_match_value

string

Responses

400

Bad request.

401

The requester is unauthorized.

404

Not found.

Language

Credentials

Bearer

Response

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

application/json

200Created Field