invite_members
Invites people to the account; each one gets an invitation email to set a password (emailed: false when invite emails are off, then they copy the join link from the Team page).
Invite team members · Changes data · Acts outside your account
Invites people to the account; each one gets an invitation email to set a password (emailed: false when invite emails are off, then they copy the join link from the Team page). Returns the new members under team (userId, preset, websites) for update_member. One invitation is used per person; a batch larger than the invitations left is refused. Members get what their role, preset or permissions allow on the websites given. Returns 405 when everyone listed is already on the account. Confirm the emails and access with the user before calling. Needs the master key.
| Connection | Account-owner URL or OAuth (not a team member URL) |
|---|
Parameters
| Parameter | Type | Required | Accepts | Description |
|---|---|---|---|---|
invites | object[] | Yes | any | One entry per person to invite. |
invites[].email | string | Yes | any | Their email address. An invitation email is sent to it. |
invites[].role | string | No | Owner, Member | Owner (everything, including billing) or Member (what permissions allow). Only an Owner can make another Owner. |
invites[].preset | string | No | full, sales, developer, viewer, team, client | Start from a preset of permissions: full, sales, developer, viewer, team or client (see get_permissions_catalog). |
invites[].permissions | string[] | No | 21 values | Exact permission ids, from get_permissions_catalog. Overrides the preset. |
invites[].allWebsites | boolean | No | any | true: access to every current and future website. |
invites[].websites | string[] | No | any | Website ids the member can see, when allWebsites is false. |
Accepted values
The exact values these fields take; anything else is refused.
invites[].permissions
pixel · add_website · website · delete_website · integrations · leads_view · leads_export · qualify · campaigns · buy_mailboxes · connect_mailboxes · warmup · inbox · optimize_seo · optimize_google_ads · optimize_meta_ads · optimize_linkedin_ads · team · api_keys · billing · whitelabel
Tool definition
What your assistant receives from tools/list:
{
"name": "invite_members",
"title": "Invite team members",
"annotations": {
"title": "Invite team members",
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": false,
"openWorldHint": true
},
"inputSchema": {
"type": "object",
"properties": {
"invites": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Their email address. An invitation email is sent to it."
},
"role": {
"type": "string",
"enum": [
"Owner",
"Member"
],
"description": "Owner (everything, including billing) or Member (what permissions allow). Only an Owner can make another Owner."
},
"preset": {
"type": "string",
"enum": [
"full",
"sales",
"developer",
"viewer",
"team",
"client"
],
"description": "Start from a preset of permissions: full, sales, developer, viewer, team or client (see get_permissions_catalog)."
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pixel",
"add_website",
"website",
"delete_website",
"integrations",
"leads_view",
"leads_export",
"qualify",
"campaigns",
"buy_mailboxes",
"connect_mailboxes",
"warmup",
"inbox",
"optimize_seo",
"optimize_google_ads",
"optimize_meta_ads",
"optimize_linkedin_ads",
"team",
"api_keys",
"billing",
"whitelabel"
]
},
"description": "Exact permission ids, from get_permissions_catalog. Overrides the preset."
},
"allWebsites": {
"type": "boolean",
"description": "true: access to every current and future website."
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "Website ids the member can see, when allWebsites is false."
}
},
"required": [
"email"
]
},
"description": "One entry per person to invite."
}
},
"required": [
"invites"
]
}
}