`signatures.prepare`

Start signing an agreement in your own portal session. Only you can, interactively; agents can't sign for you.

POST/api/v1/contractor/signatures.prepare

INTERACTIVE_SIGNATURE_REQUIRED. The contractor signs or declines in their own portal session. API and MCP calls are refused with a portalUrl to the agreement.

Permissions

contractor:readcontractor:write

Who can call it

contractor

Retries

No idempotency key, with expectedRevision

MCP

Not offered over MCP: The named contractor signs or declines in person, after verifying again.

Fields

idstring (ID)Required
The record's ID.
expectedRevisionintegerRequired
The record's current revision, from the last time you read it. If someone changed the record since, the request is refused with a conflict so you can reload and check before trying again.
at most 9007199254740991 · greater than 0

curl https://app.getoatmilk.com/api/v1/contractor/signatures.prepare \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/signatures.prepare", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/signatures.prepare",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Response

{
  "data": { … }
}

Try it

Checks your input with this action’s real schema and answers like the API, with synthetic data. No key needed, and nothing changes.

Input

POST/api/v1/contractor/signatures.prepare

curl https://app.getoatmilk.com/api/v1/contractor/signatures.prepare \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "expectedRevision": 3
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/signatures.prepare", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "expectedRevision": 3
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/signatures.prepare",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "expectedRevision": 3,
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Example

Try it