v1/mcp/import/stage

post

https://shyftplan.com/api/v1/mcp/import/stage

Stage rows for one entity. Writes nothing outside the staging area.

Body Params

Stage rows for one entity. Writes nothing outside the staging area.

company_id

int32

required

≥ 1

ID of a shyftplan account.

user_email

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

E-mail address of the API user.

authentication_token

string

required

This is a testing sandbox. We advise against using credentials for production accounts here.

Authentication token - can be fetched by login action.

allow_deletions

boolean

Defaults to false

Permit rows carrying to_be_deleted. Without this they are reported as errors.

batch_id

int32

≥ 1

Append to this batch. Omit to open a new one. A sheet with several tabs is one batch.

entity

string

enum

required

Allowed:

rows

array of objects

required

Rows keyed by the field names from describe_schema.

rows*

source_label

string

Where these rows came from, e.g. the workbook and tab name. Kept for the audit trail.

Responses

201

Batch id plus per-row complaints

400

Too many rows in one call

401

401 Unauthorized

403

Forbidden - caller cannot manage this company

404

Company or batch not found

409

Batch has already been executed