Result
generated from the schema
The body accepts ONLY the organizational part —name, relationship type, collection, tags and whether they drive—: email, phone and free text are personal data and do not travel through the public edge, just as they are not emitted on read. Returns the created member with the same projection as the listing.
Arguments
Full name.
Limits: min length 2, max length 200
Engagement type with the company.
Available options: employee, freelancer, contractor
Collection it belongs to.
Limits: min length 1
Whether they hold a driving licence. It is the field that decides who can drive a vehicle.
Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.
Limits: min length 1, max length 255
Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Unique staff member identifier.
Full name.
Staff member type.
Available options: employee, freelancer, contractor
Identifier of the collection it belongs to; null if it is in none.
Collection path it belongs to; null if not applicable.
true if they hold a driving licence.
true if they appear in the planner of the account.
External reference for matching with third-party systems; null if it has none.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs POST /api/v1/staff.
Related pages
Link to this section: Related pagesStaff
Create a staff member
Registers someone in the staff.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?