Invite Workspace Member

Invite a user to a workspace. <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning> 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. | `workspaceRole` | `defaultSiteRole` | Shown in the dashboard as | |---|---|---| | `admin` | `site_manager` | Admin | | `member` | `site_manager` | Site manager | | `member` | `designer` | Designer | | `member` | `marketer` | Marketer | | `member` | `content_editor` | Content editor | | `member` | `custom` | The custom Site Role's own name. Requires `defaultSiteRoleId`. | | `reviewer` | `reviewer` | Reviewer | Admins always have access to every site in the workspace, so an Admin invite can't include a list of specific sites. For every other role, you can either give the same role on all sites, or list specific sites. In both cases, use the pairings in the table above.