Invite Workspace Member
Invite a user to a workspace.
Set workspaceRole to client to invite a collaborator client to one Site. Client invites require exactly one siteAccess entry. Repeat the request with another Site to extend a compatible pending client invite.
Client invites create collaborator relationships only. This endpoint does not accept sitePlan or canPublish.
Required scope | workspace_members:write
workspaceRole and defaultSiteRole together decide what the invitee can do and what role the dashboard shows for them once they accept. Submit only one of the combinations below — the dashboard’s own role picker never produces any other pairing.
Admins always have access to every site in the workspace, so an Admin invite can’t include a list of specific sites. For Member and Reviewer invites, you can either give the same role on all sites, or list specific sites. In both cases, use the pairings in the table above.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Unique identifier for a Workspace. Find it with List Workspaces (workspace API tokens and Data Client apps), or with authorization.authorizedTo.workspaceIds from Get Authorization Info. With a site token, read workspaceId from Get Site.