---
title: "Give a member a role in a product"
description: "Gives someone with an existing Arbol account a role in Raíz, Agenda, Ámbar or Account, joining them to this organization when needed. They sign in with their current password. Someone without an account is invited with `invitations.create`.\n\n- **Scope:** `account:members:write`\n- **Credentials:** an API key, a client-credentials token or a person's access token\n- **Effect:** writes; not idempotent: check the outcome before you retry\n- **Limits:** request body up to 32 KB, response up to 256 KB\n- **CLI:** `arbol account members create` · **MCP tool:** `account_members_create`"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.getarbol.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Account API › Members

`POST /v1/account/members`

Gives someone with an existing Arbol account a role in Raíz, Agenda, Ámbar or Account, joining them to this organization when needed. They sign in with their current password. Someone without an account is invited with `invitations.create`.

- **Scope:** `account:members:write`
- **Credentials:** an API key, a client-credentials token or a person's access token
- **Effect:** writes; not idempotent: check the outcome before you retry
- **Limits:** request body up to 32 KB, response up to 256 KB
- **CLI:** `arbol account members create` · **MCP tool:** `account_members_create`

## Authentication

Requires one of the following:

- `arbolHuman`, oauth2, scopes: `account:members:write`
- `arbolMachine`, oauth2, scopes: `account:members:write`
- `arbolApiKey`, http, header `Authorization`

## Request body

_Required._

- `email` (`account.members.create.email`; string, required) — The email of someone with an existing Arbol account, in this organization or another.
  - format `email`; maxLength 320
- `product` (`account.members.create.product`; string, required) — A product whose team Account administers: Raíz, Agenda, Ámbar or Account itself.
  - one of `"raiz"`, `"agenda"`, `"ambar"`, `"account"`
- `role` (`account.members.create.role`; string, required) — A role name, such as calendar:operator.
  - minLength 1; maxLength 128

## Example request

```json
{
  "email": "user@example.com",
  "product": "raiz",
  "role": "string"
}
```

## Code samples

### cURL

```bash
curl https://api.getarbol.com/v1/account/members \
  --request POST \
  --header "Authorization: Bearer $ARBOL_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "email": "name@example.com",
  "product": "raiz",
  "role": "<role>"
}'
```

### TypeScript

```typescript
import { createClient } from "@arbol-ai/sdk";

const arbol = createClient({
  baseUrl: "https://api.getarbol.com",
  token: process.env.ARBOL_API_KEY!,
});

const { data } = await arbol.account.members.create({
  email: "name@example.com",
  product: "raiz",
  role: "<role>",
});
```

### Rust

```rust
use arbol_sdk::{types, Client, Credential};

let arbol = Client::new(Credential::ApiKey(std::env::var("ARBOL_API_KEY")?))?;

let data = arbol
    .account()
    .members()
    .create(&types::AccountMembersCreateInput {
        email: "name@example.com".into(),
        product: types::AccountMembersCreateInputProduct::Raiz,
        role: "<role>".into(),
    })
    .await?;
```

### CLI

```bash
arbol account members create --email name@example.com --product raiz --role '<role>'
```

### MCP

```json
{
  "name": "account_members_create",
  "arguments": {
    "email": "name@example.com",
    "product": "raiz",
    "role": "<role>"
  }
}
```

## Responses

### 200

Successful operation.

#### Example

```json
{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "email": "string",
    "picture": "string",
    "roles": [
      {
        "product": "raiz",
        "role": "string"
      }
    ],
    "protected": true,
    "self": true
  },
  "error": null,
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.200.success`; boolean, required)
  - one of `true`
- `data` (`account.members.create.response.200.data`; object, required)
  - `id` (`account.members.create.response.200.data.id`; string, required)
    - minLength 1; maxLength 256
  - `name` (`account.members.create.response.200.data.name`; string | null, required)
    - maxLength 1024
  - `email` (`account.members.create.response.200.data.email`; string | null, required)
    - maxLength 320
  - `picture` (`account.members.create.response.200.data.picture`; string | null, required)
    - maxLength 2048
  - `roles` (`account.members.create.response.200.data.roles`; array<object>, required) — Their roles in the products Account administers, and a product's owner role, which only Arbol assigns.
    - `product` (`account.members.create.response.200.data.roles.product`; string, required) — A product whose team Account administers: Raíz, Agenda, Ámbar or Account itself.
      - one of `"raiz"`, `"agenda"`, `"ambar"`, `"account"`
    - `role` (`account.members.create.response.200.data.roles.role`; string, required) — A role name, such as calendar:operator.
      - minLength 1; maxLength 128
  - `protected` (`account.members.create.response.200.data.protected`; boolean, required) — They hold access only Arbol changes (owner, staff).
  - `self` (`account.members.create.response.200.data.self`; boolean, required) — The caller themselves.
- `error` (`account.members.create.response.200.error`; unknown, required)
- `metadata` (`account.members.create.response.200.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.200.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 400

`INVALID_INPUT`: The request does not match the published schema.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": false,
    "data": {
      "issues": [
        {
          "path": "string",
          "message": "string"
        }
      ]
    }
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.400.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.400.data`; unknown, required)
- `error` (`account.members.create.response.400.error`; object, required) — The request does not match the published schema.
  - `code` (`account.members.create.response.400.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INVALID_INPUT"`
  - `message` (`account.members.create.response.400.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.400.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.400.error.data`; object, required)
    - `issues` (`account.members.create.response.400.error.data.issues`; array<object>, optional)
      - `path` (`account.members.create.response.400.error.data.issues.path`; string, required) — RFC 6901 JSON Pointer to the refused field; empty for the whole input.
        - maxLength 256
      - `message` (`account.members.create.response.400.error.data.issues.message`; string, required)
        - maxLength 256
- `metadata` (`account.members.create.response.400.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.400.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 401

`UNAUTHORIZED`: A valid access token is required.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.401.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.401.data`; unknown, required)
- `error` (`account.members.create.response.401.error`; object, required) — A valid access token is required.
  - `code` (`account.members.create.response.401.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNAUTHORIZED"`
  - `message` (`account.members.create.response.401.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.401.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.401.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.401.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.401.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 403

- `FORBIDDEN`: The token does not authorize this operation.
- `MEMBER_PROTECTED`: This person holds access that only Arbol changes.
- `MEMBER_SELF_CHANGE`: You cannot change your own access.
- `ROLE_NOT_ASSIGNABLE`: You cannot assign this role.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "FORBIDDEN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.403.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.403.data`; unknown, required)
- `error` (`account.members.create.response.403.error`; one of, required)
  - one of: `ForbiddenFailure`, `AccountMemberProtectedFailure`, `AccountMemberSelfChangeFailure`, `AccountRoleNotAssignableFailure`
  - discriminator: `code`
- `metadata` (`account.members.create.response.403.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.403.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 404

`MEMBER_NOT_FOUND`: No existing Arbol account was found.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "MEMBER_NOT_FOUND",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.404.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.404.data`; unknown, required)
- `error` (`account.members.create.response.404.error`; object, required) — No existing Arbol account was found.
  - `code` (`account.members.create.response.404.error.code`; string, required) — The failure code, stable across releases.
    - one of `"MEMBER_NOT_FOUND"`
  - `message` (`account.members.create.response.404.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.404.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.404.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.404.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.404.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 409

- `IDENTITY_REJECTED`: The identity service refused the change.
- `LAST_ADMINISTRATOR`: The product must keep at least one administrator.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "IDENTITY_REJECTED",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.409.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.409.data`; unknown, required)
- `error` (`account.members.create.response.409.error`; one of, required)
  - one of: `AccountIdentityRejectedFailure`, `AccountLastAdministratorFailure`
  - discriminator: `code`
- `metadata` (`account.members.create.response.409.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.409.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 413

`REQUEST_TOO_LARGE`: The request exceeds the allowed size.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "REQUEST_TOO_LARGE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.413.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.413.data`; unknown, required)
- `error` (`account.members.create.response.413.error`; object, required) — The request exceeds the allowed size.
  - `code` (`account.members.create.response.413.error.code`; string, required) — The failure code, stable across releases.
    - one of `"REQUEST_TOO_LARGE"`
  - `message` (`account.members.create.response.413.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.413.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.413.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.413.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.413.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 415

`UNSUPPORTED_MEDIA_TYPE`: The request content type is not supported.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.415.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.415.data`; unknown, required)
- `error` (`account.members.create.response.415.error`; object, required) — The request content type is not supported.
  - `code` (`account.members.create.response.415.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UNSUPPORTED_MEDIA_TYPE"`
  - `message` (`account.members.create.response.415.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.415.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.415.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.415.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.415.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 429

`RATE_LIMITED`: The request rate limit was exceeded. Try again later.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "RATE_LIMITED",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.429.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.429.data`; unknown, required)
- `error` (`account.members.create.response.429.error`; object, required) — The request rate limit was exceeded. Try again later.
  - `code` (`account.members.create.response.429.error.code`; string, required) — The failure code, stable across releases.
    - one of `"RATE_LIMITED"`
  - `message` (`account.members.create.response.429.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.429.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`account.members.create.response.429.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.429.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.429.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 500

`INTERNAL_ERROR`: The service could not complete the operation.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.500.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.500.data`; unknown, required)
- `error` (`account.members.create.response.500.error`; object, required) — The service could not complete the operation.
  - `code` (`account.members.create.response.500.error.code`; string, required) — The failure code, stable across releases.
    - one of `"INTERNAL_ERROR"`
  - `message` (`account.members.create.response.500.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.500.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.500.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.500.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.500.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 502

`OUTCOME_UNKNOWN`: The operation may have been applied; check its result before repeating it.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "OUTCOME_UNKNOWN",
    "message": "string",
    "retryable": false,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.502.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.502.data`; unknown, required)
- `error` (`account.members.create.response.502.error`; object, required) — The operation may have been applied; check its result before repeating it.
  - `code` (`account.members.create.response.502.error.code`; string, required) — The failure code, stable across releases.
    - one of `"OUTCOME_UNKNOWN"`
  - `message` (`account.members.create.response.502.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.502.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `false`
  - `data` (`account.members.create.response.502.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.502.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.502.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 503

- `UPSTREAM_UNAVAILABLE`: The upstream service could not complete the request.
- `ACCOUNT_NOT_CONFIGURED`: Account administration is not configured yet.
- `IDENTITY_UNAVAILABLE`: The identity service did not answer.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_UNAVAILABLE",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.503.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.503.data`; unknown, required)
- `error` (`account.members.create.response.503.error`; one of, required)
  - one of: `UpstreamUnavailableFailure`, `AccountAccountNotConfiguredFailure`, `AccountIdentityUnavailableFailure`
  - discriminator: `code`
- `metadata` (`account.members.create.response.503.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.503.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.

### 504

`UPSTREAM_TIMEOUT`: The upstream service did not respond before its deadline.

#### Example

```json
{
  "success": false,
  "data": null,
  "error": {
    "code": "UPSTREAM_TIMEOUT",
    "message": "string",
    "retryable": true,
    "data": {}
  },
  "metadata": {
    "requestId": "string"
  }
}
```

- `success` (`account.members.create.response.504.success`; boolean, required)
  - one of `false`
- `data` (`account.members.create.response.504.data`; unknown, required)
- `error` (`account.members.create.response.504.error`; object, required) — The upstream service did not respond before its deadline.
  - `code` (`account.members.create.response.504.error.code`; string, required) — The failure code, stable across releases.
    - one of `"UPSTREAM_TIMEOUT"`
  - `message` (`account.members.create.response.504.error.message`; string, required) — What went wrong, for people; it never contains input values.
  - `retryable` (`account.members.create.response.504.error.retryable`; boolean, required) — Whether repeating the same request may succeed.
    - one of `true`
  - `data` (`account.members.create.response.504.error.data`; object, required) — No fields.
- `metadata` (`account.members.create.response.504.metadata`; object, required) — What every answer carries besides its data or error.
  - `requestId` (`account.members.create.response.504.metadata.requestId`; string, required) — Request correlation identifier, also sent as X-Request-Id.


Source: https://docs.getarbol.com/api/account/members/create/index.md
