Organisation
Create Invite
Invite someone to join your organisation by email, with the roles they get on joining.
POST
Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive
403 mcp_not_enabled. See the preview overview.email. When the invitee accepts, they become a member with the roles you set.
The invite lasts 30 days. If the email goes astray, use Resend Invite rather than creating a second invite. To cancel it, use Revoke Invite.
The response never includes the join link. Wordsmith only sends it to the invitee’s inbox.
Authentication
Requires an API key, or an OAuth token withdirectory:admin. The caller must also be an organisation admin, or hold a role with the matching permission. directory:admin is never granted by default. It only narrows what the person who approved it can already do, so a team admin’s token can edit their own teams and nothing else. Admin changes are not available through the MCP server.
Giving the invitee a custom role also needs the permission to assign roles.
Body parameters
string
required
The invitee’s email address.
string[]
Built-in roles for the invitee: any of
viewer, full_user and admin. If you send neither predefined_roles nor custom_role_ids, your organisation’s default roles for new members apply. That default is ["full_user"] unless an admin changed it in Settings.string[]
Custom roles for the invitee, from List Roles. Needs a plan that includes custom roles.
Response
Returns201 with the new invite, with status set to pending.
If this email already has a pending invite, Wordsmith sends nothing and returns 200 with that invite, unchanged. Use Resend Invite to email it again.