POST
/v1/workspace/directory/inviteInvite people from the directory
Mints one invite link per address named, for addresses the connected directory actually holds, at the seat given or the workspace's configured default. Per address it answers what happened - invited, seated, invited_already or not_in_directory - so nothing is double-invited, and the links come back in links, the one and only place each token exists. Reach for it after reading the directory to let named people in.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Request body
application/jsonrequiredbodyoptional
paramsobjectoptional
queryoptional
Responses
201application/json
the action's answer
{}defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired