Transactions

cards.claim

Update the caller's card claims atomically: identifierIds claims unassigned cards, releaseIdentifierIds releases only cards the caller personally claimed, seenIdentifierIds records what they reviewed, and idempotencyKey prevents duplicate saves. Other people's cards and finance-managed assignments cannot be changed; administrators reassign those in Cards.

POST/api/v1/accounting/cards.claim

Permissions

accounting:readaccounting:write

Who can call it

admin, finance, contributor

Retries

Idempotency key required

MCP

accounting_cards_claim

Fields

  • identifierIdsarray of strings (ID)Required

    A list of record IDs.

    at most 10 items

  • releaseIdentifierIdsarray of strings (ID)

    A list of record IDs.

    at most 10 items · Default []

  • seenIdentifierIdsarray of strings (ID)

    A list of record IDs.

    at most 200 items · Default []

  • 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/cards.claim \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "identifierIds": [
    "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a"
  ]
}'
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/cards.claim
curl https://app.getoatmilk.com/api/v1/accounting/cards.claim \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "identifierIds": [
    "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a"
  ]
}'

More in Transactions.