---
title: "Invite a team member"
method: POST
path: "/v1/teams/{team}/members"
tags: ["Team Members"]
---

# Invite a team member

`POST /v1/teams/{team}/members`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/teams/{team}/members`
- Auth: HTTP bearer

```bash
curl -X POST https://api.subscriby.net/v1/teams/$TEAM_ID/members \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"email": "newcomer@example.com", "role": "support-agent"}'
```

Addressed by **email**, not user id: the invitee may not have a Subscriby account yet, which is what separates inviting from adding. They receive an invitation message with a link; the membership row appears when they accept.

`role` is a role **code** on that team, such as `support-agent`, not a role id. Create it first with [Roles](https://docs.subscriby.net/api/v1/reference/roles) if it does not exist.

Answers `201` with the invitation summary. Emits `team.member.invited`, then `team.member.joined` when they accept.

## Path parameters

- `team` string, uuid, required

## Headers

- `Idempotency-Key` string, uuid, required

## Request body

- InviteTeamMemberRequest: Who to invite and as what. An invitation names an email rather than a user, because the invitee may not have an account yet.
  - `email` string, email, required: The invitee's email address, up to 255 characters. They receive an invitation message with a link; the membership appears when they accept.
  - `role` string, required: A role **code** on that team, such as `support-agent`, not a role id. Create it first if it does not exist; an unknown code is refused.

## Response `201`

201 with the invitation summary.

- object
  - `data` object, required: The response's payload.
    - `team_id` string, required: The team the invitation is for.
    - `email` string, required: The address the invitation was sent to.
    - `role` string, required: The role code the invitee will hold on accepting.
    - `status` 'invited', required: Always `invited`: the membership appears on acceptance.

## Other responses

- `400`: `IDEMPOTENCY_KEY_MISSING`: every write needs an `Idempotency-Key` header. Send a fresh UUID per distinct operation.
- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description. On this endpoint: `TEAM_TIER_REQUIRED`: below the Growth tier; nothing changes.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `409`: `IDEMPOTENCY_KEY_REUSED`: the key was already used in the last 24 hours with a different request body.
- `422`: `VALIDATION_FAILED`: the payload broke a rule, and `error.fields` maps each offending key to its messages. A refusal from the domain, such as a plan that cannot go on sale or a member who cannot be removed, uses the same code with `error.message` saying why and no `fields`. On this endpoint: `VALIDATION_FAILED`: when the role code is not one of the team's, or the invitee is already in the team.
- `425`: `IDEMPOTENCY_REPLAY_IN_PROGRESS`: the first request with this key is still running; retry in a few seconds and the original response is replayed.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)