PlatformDocs

Team members

Invite people and choose what they can do and which websites they see.

View as Markdown

Connect the MCP server, then just ask.

list_membersLists the people on the account as team: userId, name, email, role (Owner or Member), permissions, preset, allWebsites, websites (website ids, empty when allWebsites is true) and whether their invite is still pending (invitePending).Read-only
get_permissions_catalogReturns every permission a member can be given and the presets (full, sales, developer, viewer, team, client) with the permissions each one ticks.Read-only
invite_membersInvites 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).Changes data
update_memberChanges a member's role, permissions or websites and returns the member as list_members does.Changes data
remove_memberRemoves a person from the account: they lose access straight away, their website access is removed and the invitation is given back.Deletes data

Use case

Invite sam@yourcompany.example as a sales member on all websites.

Called invite_membersShow input
{
  "invites": [
    {
      "email": "sam@yourcompany.example",
      "role": "Member",
      "preset": "sales",
      "allWebsites": true
    }
  ]
}

Each person gets an invitation email to set a password, unless invite emails are switched off; the answer then says emailed: false, and you copy their join link from the Team page. The answer lists the new members under team, with their userId. Every person uses one of your plan's invitations, and a batch larger than what you have left is refused.

Who is on my team, and what can each person do?

Called list_membersShow input
{}

Each person comes back with their userId, role, preset, exact permissions, allWebsites, the website ids they can see (websites, empty when they see all of them) and invitePending while they haven't accepted yet.

What does the Sales preset let someone do?

Called get_permissions_catalogShow input
{}

Limit Jo to our main website only.

Called update_memberShow input
{ "userId": "6650a1b2c3d4e5f6a7b8c9e1", "allWebsites": false, "websites": ["64b7f0a1c2d3e4f5a6b7c8d9"] }

Only what you send changes. websites replaces their whole list, so send every website they should keep, with allWebsites: false. Giving an Owner a preset or permissions makes them a Member.

Remove Jo from the account.

Called remove_memberShow input
{ "userId": "6650a1b2c3d4e5f6a7b8c9e1" }

Your assistant gets the userId from list_members first. It can only give the permissions and websites you have yourself, and never removes the last Owner. Only an Owner can remove another Owner. A removed person loses access straight away, and their invitation goes back to you to use on someone else.

On this page