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

# Invite member

> Invite one email address as admin, member or viewer, optionally scoped to specific projects.

`invite_member`

Invite one email address as admin, member or viewer, optionally scoped to specific projects. Returns a join token ONCE; only its hash is stored. The token alone is NOT enough to join ,  the accepting user's VERIFIED email must match the invitation, so a forwarded link cannot admit a stranger. An invitation can never grant a role or a project the inviter does not hold, and owner is not invitable: transferring ownership is its own act. Linktrail does not send the email; hand the token to the person yourself.

<Note>Hosted MCP registration verified. These schemas describe the development contract; confirm supported inputs with tools/list. Generic CLI/HTTP calls require a matching development server. Configure LINKTRAIL\_API\_URL; production does not expose these command routes.</Note>

| Access           | Behavior              |
| ---------------- | --------------------- |
| `projects:write` | Writes or admits work |

Reading saved data does not start a verification job. Mutations can change saved records or access; the effects below apply.

## Example request

Connect through [MCP](/guides/connect-mcp), [CLI](/guides/connect-cli), or [HTTP](/guides/connect-http). Replace example identifiers with records from your workspace.

<CodeGroup>
  ```json MCP theme={null}
  {
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/call",
    "params": {
      "name": "invite_member",
      "arguments": {
        "email": "reader@example.com"
      }
    }
  }
  ```

  ```bash CLI theme={null}
  linktrail call invite_member --args '{"email":"reader@example.com"}'
  ```

  ```bash HTTP theme={null}
  curl "$LINKTRAIL_API_URL/v1/commands/invite_member" \
    -H "Authorization: Bearer $LINKTRAIL_API_KEY" \
    -H 'Content-Type: application/json' \
    --data '{"email":"reader@example.com"}'
  ```
</CodeGroup>

## Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in `structuredContent` and in a text content block; generic HTTP and CLI return the JSON result directly.

```json theme={null}
{
  "id": "invite_example",
  "workspace_id": "ws_example",
  "email": "reader@example.com",
  "role": "member",
  "project_ids": null,
  "invited_by": "user_example",
  "created_at": "2026-09-13T12:00:00.000Z",
  "expires_at": "2026-09-20T12:00:00.000Z",
  "accepted_at": null,
  "revoked_at": null,
  "state": "open",
  "token": "example_invitation_token_not_a_credential"
}
```

## Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

| Field        | Type   | Presence | Meaning and constraints                                                                                                    |
| ------------ | ------ | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| `email`      | string | Required | Email address to bind an invitation to; Linktrail does not send the invitation. minLength: 3; maxLength: 254               |
| `role`       | string | Optional | Workspace access role; cannot exceed the acting member’s authority. default: "member"; values: "admin", "member", "viewer" |
| `projectIds` | array  | Optional | Accessible project IDs. Where nullable, null grants all projects. minItems: 1; maxItems: 100                               |

### Validation and omitted values

Omitting projectIds requests workspace-wide access; it cannot exceed the inviter grant. The accepting user must have the matching verified email. The returned token is shown once; this operation does not send email.

### Defaults when omitted

| Field  | Default    |
| ------ | ---------- |
| `role` | `"member"` |

## Output fields

Fields inside optional or nullable parents apply only when that parent exists. [Common schema conventions](/reference/schemas) explain evidence states, empty lists and extensions.

| Field          | Type          | Presence | Meaning and constraints                                                                                  |
| -------------- | ------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `id`           | string        | Required | Resource identifier returned by the operation.                                                           |
| `workspace_id` | string        | Required | Workspace that owns this record.                                                                         |
| `email`        | string        | Required | email recorded for this result.                                                                          |
| `role`         | string        | Required | role recorded for this result.                                                                           |
| `project_ids`  | array / null  | Required | Accessible project identifiers; null grants access to all workspace projects.                            |
| `invited_by`   | string        | Required | invited by recorded for this result.                                                                     |
| `created_at`   | string        | Required | UTC timestamp when the record was created.                                                               |
| `expires_at`   | string        | Required | expires at recorded for this result.                                                                     |
| `accepted_at`  | string / null | Required | accepted at recorded for this result.                                                                    |
| `revoked_at`   | string / null | Required | revoked at recorded for this result.                                                                     |
| `state`        | string        | Required | Saved lifecycle or evidence state, as enumerated for this record.                                        |
| `token`        | string        | Optional | Invitation token returned only at creation. The accepting account must have the matching verified email. |

[Download input schema](/schemas/invite_member.input.json) · [Download output schema](/schemas/invite_member.output.json)

## Errors and retries

This command is not annotated idempotent. After a timeout, inspect existing state before repeating a write.

See [error recovery](/reference/errors) for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

## HTTP resource routes

These existing resource routes share the operation’s domain behavior. Their parameter placement, status and response envelope can differ from generic invocation. See [HTTP route details](/reference/http/routes).

| Method and route       | Success | Details                                       |
| ---------------------- | ------- | --------------------------------------------- |
| `POST /v1/invitations` | 201     | Remaining arguments go in a JSON object body. |

## Continue

[list\_invitations](/reference/commands/list_invitations) · [list\_members](/reference/commands/list_members)

Follow the [related workflow](/guides/connect-http), inspect [capability status](/capability-status), or return to the [command index](/reference/index).