---
title: "Invite a member to the workspace with per-screen none/read/write access (unspecified screens default to none — grant at least one). Dry-run unless confirm is true; confirming sends the invite email. When the person asked for this, call it with confirm=true."
method: POST
path: "/api/v1/team/invite"
---

# Invite a member to the workspace with per-screen none/read/write access (unspecified screens default to none — grant at least one). Dry-run unless confirm is true; confirming sends the invite email. When the person asked for this, call it with confirm=true.

`POST /api/v1/team/invite`

## Request

- Base URL: `https://api.rctrl.com`
- URL: `https://api.rctrl.com/api/v1/team/invite`
- Auth: HTTP bearer

Requires the `manage:org` scope.

## Request body

- object
  - `email` string, required: Invitee email address
  - `screenPermissions` object: Access per screen: none, read or write. Screens you leave out get none.
    - `overview` 'none' | 'read' | 'write': Overview screen access
    - `content` 'none' | 'read' | 'write': Content screen access
    - `visibility` 'none' | 'read' | 'write': Visibility screen access
    - `brandControl` 'none' | 'read' | 'write': Brand Control screen access
    - `linkControl` 'none' | 'read' | 'write': Link Control screen access
    - `analytics` 'none' | 'read' | 'write': Analytics screen access
    - `reports` 'none' | 'read' | 'write': Reports screen access
  - `confirm` boolean: Set true to actually send the invite (default dry-run)

## Response `200`

Success; the payload is wrapped in a data envelope

- object
  - `data` unknown

## Other responses

- `400`: Bad input
- `401`: Missing or invalid API key
- `403`: API key lacks the required scope
- `404`: Not found in this workspace
- `429`: Rate limited; the body includes a retryAfterMs hint

---

[API](https://skmtc.dev/rctrl/apis/rankcontrol-api.md) · [All operations](https://skmtc.dev/rctrl/apis/rankcontrol-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rctrl/apis/rankcontrol-api/revisions/98ecd236394a?raw)