`onboarding.save`

Record which setup questions you answered or skipped, whether you finished, and whether you agree to get your tax slips and pay statements by email. It changes nothing else about your profile. Over the API and MCP only answered, skipped and completed are accepted: agreeing to get tax slips by email (eDelivery) is the person's own choice in the portal and is refused with INTERACTIVE_PORTAL_REQUIRED.

POST/api/v1/contractor/onboarding.save

Permissions

contractor:readcontractor:write

Who can call it

contractor

Retries

Idempotency key required

MCP

contractor_onboarding_save

Fields

idempotencyKeystringRequired
Any unique text you generate once per intended change, so a retried request only happens once. Send it as the Idempotency-Key header instead if you prefer; if you send both they must match.
8–200 characters
answeredarray of strings
at most 40 items · each Matches ^[A-Za-z]{2,30}$
skippedarray of strings
at most 40 items · each Matches ^[A-Za-z]{2,30}$
eDeliveryboolean
eDeliveryVersionstring
Matches ^[0-9A-Za-z._-]{1,20}$
completedboolean

curl https://app.getoatmilk.com/api/v1/contractor/onboarding.save \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "answered": [
    "answered"
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/onboarding.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "answered": [
      "answered"
    ]
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/onboarding.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "answered": [
            "answered",
        ],
    },
    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/onboarding.save

curl https://app.getoatmilk.com/api/v1/contractor/onboarding.save \
  -H "Authorization: Bearer $OATMILK_OAUTH_TOKEN" \
  -H "X-Accounting-Organization: $OATMILK_ORGANIZATION_ID" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "answered": [
    "answered"
  ]
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/contractor/onboarding.save", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_OAUTH_TOKEN}`,
    "X-Accounting-Organization": process.env.OATMILK_ORGANIZATION_ID,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "answered": [
      "answered"
    ]
  }),
});
const { data, error } = await response.json();
if (!response.ok) throw new Error(`${error.code}: ${error.message}`);
console.log(data);

import os
import uuid

import requests

response = requests.post(
    "https://app.getoatmilk.com/api/v1/contractor/onboarding.save",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_OAUTH_TOKEN']}",
        "X-Accounting-Organization": os.environ["OATMILK_ORGANIZATION_ID"],
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "answered": [
            "answered",
        ],
    },
    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