Sign in
Users
v1

Invite User to Account

Sends an invitation to the specified email address, granting the user access to the account with the provided permissions. If the email already belongs to an existing Leadfeeder user, the invitation is accepted automatically.

:::info Requires the users:write OAuth2 scope. :::

post/v1/account-users

Query parameters

account_idstring required

The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.

Request body

Example request

{
  "data": {
    "attributes": {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "permissions": [
        "web_visitors.product_access",
        "web_visitors.custom_feed"
      ]
    }
  }
}

Response

Account user details

Example response

{
  "data": {
    "type": "account_user",
    "id": "123456",
    "attributes": {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith",
      "invitation_accepted": true,
      "permissions": [
        "web_visitors.product_access",
        "web_visitors.custom_feed"
      ]
    }
  },
  "meta": {
    "request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
  }
}

Changes