`organization.migration.receive`

Prepare an empty destination organization for a migration and freeze its writes. Auth accounts and credentials are not imported. Explicit replaceSetup allows replacing only initial settings and categories.

POST/api/v1/accounting/organization.migration.receive

Permissions

accounting:readaccounting:writeaccounting:admin

Who can call it

admin

Retries

No idempotency key

MCP

Not offered over MCP: Organization data moves need administrator sign-ins at both installations and an explicit cutover in Settings or the CLI.

Fields

idstring (ID)Required
The record's ID.
manifestobjectRequired
No other fields
peerHoststring (uri)Required
at most 2000 characters
identityMapmapRequired
replaceSetupboolean
Default false
dryRunboolean
Default false

curl https://app.getoatmilk.com/api/v1/accounting/organization.migration.receive \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "manifest": {
    "version": 1,
    "organizationId": "organization_id",
    "tables": [
      {
        "name": "name",
        "columns": [
          {
            "name": "name",
            "type": "example",
            "required": true,
            "hasDefault": true,
            "generated": true
          }
        ],
        "rows": 1
      }
    ],
    "files": [
      {
        "bucket": "example",
        "path": "example",
        "size": 1
      }
    ],
    "excluded": [
      {
        "table": "table",
        "rows": 1
      }
    ],
    "blockers": [
      "example"
    ],
    "userIds": [
      "example"
    ]
  },
  "peerHost": "https://example.com/webhooks/oatmilk",
  "identityMap": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/organization.migration.receive", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "manifest": {
      "version": 1,
      "organizationId": "organization_id",
      "tables": [
        {
          "name": "name",
          "columns": [
            {
              "name": "name",
              "type": "example",
              "required": true,
              "hasDefault": true,
              "generated": true
            }
          ],
          "rows": 1
        }
      ],
      "files": [
        {
          "bucket": "example",
          "path": "example",
          "size": 1
        }
      ],
      "excluded": [
        {
          "table": "table",
          "rows": 1
        }
      ],
      "blockers": [
        "example"
      ],
      "userIds": [
        "example"
      ]
    },
    "peerHost": "https://example.com/webhooks/oatmilk",
    "identityMap": {}
  }),
});
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/accounting/organization.migration.receive",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "manifest": {
            "version": 1,
            "organizationId": "organization_id",
            "tables": [
                {
                    "name": "name",
                    "columns": [
                        {
                            "name": "name",
                            "type": "example",
                            "required": True,
                            "hasDefault": True,
                            "generated": True,
                        },
                    ],
                    "rows": 1,
                },
            ],
            "files": [
                {
                    "bucket": "example",
                    "path": "example",
                    "size": 1,
                },
            ],
            "excluded": [
                {
                    "table": "table",
                    "rows": 1,
                },
            ],
            "blockers": [
                "example",
            ],
            "userIds": [
                "example",
            ],
        },
        "peerHost": "https://example.com/webhooks/oatmilk",
        "identityMap": {},
    },
    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/accounting/organization.migration.receive

curl https://app.getoatmilk.com/api/v1/accounting/organization.migration.receive \
  -H "Authorization: Bearer $OATMILK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "manifest": {
    "version": 1,
    "organizationId": "organization_id",
    "tables": [
      {
        "name": "name",
        "columns": [
          {
            "name": "name",
            "type": "example",
            "required": true,
            "hasDefault": true,
            "generated": true
          }
        ],
        "rows": 1
      }
    ],
    "files": [
      {
        "bucket": "example",
        "path": "example",
        "size": 1
      }
    ],
    "excluded": [
      {
        "table": "table",
        "rows": 1
      }
    ],
    "blockers": [
      "example"
    ],
    "userIds": [
      "example"
    ]
  },
  "peerHost": "https://example.com/webhooks/oatmilk",
  "identityMap": {}
}'

const response = await fetch("https://app.getoatmilk.com/api/v1/accounting/organization.migration.receive", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.OATMILK_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "manifest": {
      "version": 1,
      "organizationId": "organization_id",
      "tables": [
        {
          "name": "name",
          "columns": [
            {
              "name": "name",
              "type": "example",
              "required": true,
              "hasDefault": true,
              "generated": true
            }
          ],
          "rows": 1
        }
      ],
      "files": [
        {
          "bucket": "example",
          "path": "example",
          "size": 1
        }
      ],
      "excluded": [
        {
          "table": "table",
          "rows": 1
        }
      ],
      "blockers": [
        "example"
      ],
      "userIds": [
        "example"
      ]
    },
    "peerHost": "https://example.com/webhooks/oatmilk",
    "identityMap": {}
  }),
});
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/accounting/organization.migration.receive",
    headers={
        "Authorization": f"Bearer {os.environ['OATMILK_API_KEY']}",
    },
    json={
        "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
        "manifest": {
            "version": 1,
            "organizationId": "organization_id",
            "tables": [
                {
                    "name": "name",
                    "columns": [
                        {
                            "name": "name",
                            "type": "example",
                            "required": True,
                            "hasDefault": True,
                            "generated": True,
                        },
                    ],
                    "rows": 1,
                },
            ],
            "files": [
                {
                    "bucket": "example",
                    "path": "example",
                    "size": 1,
                },
            ],
            "excluded": [
                {
                    "table": "table",
                    "rows": 1,
                },
            ],
            "blockers": [
                "example",
            ],
            "userIds": [
                "example",
            ],
        },
        "peerHost": "https://example.com/webhooks/oatmilk",
        "identityMap": {},
    },
    timeout=30,
)
payload = response.json()
if not response.ok:
    raise RuntimeError(f"{payload['error']['code']}: {payload['error']['message']}")
print(payload["data"])

Fields

Fields inside manifest

Example

Try it