Sign a contract with its public token

POST

/api/v1/contracts/{id}/sign

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/contracts/example/sign \
  --header 'Content-Type: application/json' \
  --data '{ "token": "example", "signature_name": "example", "signature_data": "example" }'

Unauthenticated; requires the public token, signature_name and signature_data. The contract must have been sent and not yet signed; emits contract.signed.

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

token

required

string

>= 1 characters

signature_name

required

string

>= 1 characters <= 200 characters

signature_data

required

string

>= 1 characters <= 100000 characters

Example^generated

{
  "token": "example",
  "signature_name": "example",
  "signature_data": "example"
}

Responses

200

OK

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}