Update presigned contract

curl --request PATCH \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "contract_type_id": 123,
  "labels": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contract_type_id: 123, labels: ['<string>']})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id}"

payload = {
    "contract_type_id": 123,
    "labels": ["<string>"]
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "payload": {}
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{}

{}

Presigned Contracts

Update presigned contract

Answers the contract type and the labels of a contract signed outside Yampi. The signing date and the lease conditions are declared through the lease review endpoint, and the parties through the contract submitter endpoints. A request that carries signed_date, tenant_email, tenant_name, property_address, contact_id, conditions or skip_automation, or neither contract_type_id nor labels, is refused with 422 and changes nothing.

PATCH

api

accounts

{account_id}

presigned_contracts

{id}

Update presigned contract

curl --request PATCH \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "contract_type_id": 123,
  "labels": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contract_type_id: 123, labels: ['<string>']})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/presigned_contracts/{id}"

payload = {
    "contract_type_id": 123,
    "labels": ["<string>"]
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "payload": {}
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{}

{}

Authorizations

api_access_token

string

header

required

Path Parameters

integer

required

ID of the presigned contracts

account_id

integer

required

The numeric ID of the account

Body

application/json

contract_type_id

integer

An active contract type of the account.

labels

string[]

Response

Success

payload

object