OatmilkDevelopers

Reports and tax

tax.prizes.recipients.save

Add a winner (individual or business), edit them, or archive them. With sendLink and an email address Oatmilk emails the winner a private, account-free link for their legal name, SIN or business number and mailing address, before any payment. The email never contains a number.

POST/api/v1/accounting/tax.prizes.recipients.save

Permissions

accounting:readaccounting:write

Who can call it

admin, finance

Retries

Idempotency key required, with expectedRevision

MCP

accounting_tax_prizes_recipients_save

Reaches outside Oatmilk

It emails people or calls another service.

Fields

Shape 1: op: "create"

  • op"create"Required
  • kindenum

    Which kind of record or job this is.

    individualbusiness

    Default "individual"

  • displayNamestringRequired

    1–200 characters

  • emailstring (email)

    An email address.

    at most 254 characters

  • 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

Shape 2: op: "update"

  • op"update"Required
  • 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

  • kindenum

    Which kind of record or job this is.

    individualbusiness
  • displayNamestringRequired

    1–200 characters

  • emailstring (email) or null

    An email address.

  • 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

Shape 3: op: "archive"

  • op"archive"Required
  • 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

  • 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

Example

curl https://app.getoatmilk.com/api/v1/accounting/tax.prizes.recipients.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "op": "create",
  "displayName": "Synthetic Ventures Inc."
}'
Response
{
  "data": { … }
}

Try it

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.

POST/api/v1/accounting/tax.prizes.recipients.save
curl https://app.getoatmilk.com/api/v1/accounting/tax.prizes.recipients.save \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "op": "create",
  "displayName": "Synthetic Ventures Inc."
}'

More in Reports and tax.