# Invite someone to the team

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/setting/invite
```

- API version: v1
- Operation ID: `v1_public_invite_store`
- Section: Team settings › [Team invitations](https://developer.yoprint.com/reference/team-invitations.md)
- Web page: https://developer.yoprint.com/reference/team-invitations/v1-invite-store/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Invites a person by email, with the permission group they'll join with, and emails them a link.

- Someone who already has a YoPrint account gets an email to join your team.
- Anyone else gets an email to create an account and join.

They join when they accept. Until then the invitation is in the invitations list; it expires after two months.

The response has no data. Read the invitations list to get the new invitation's id.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Business rules

- One pending invitation per email address: delete the old one before inviting again.
- Someone already on the team can't be invited.
- Your plan's user limit counts members plus every invitation in the list. When the next one would pass it, you get 403.
- `role_id` must be one of this team's permission groups (404 otherwise).

## Side effects

- Sends the invitation email.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `email` (string (email), required): Their email address, in standard English letters and symbols. Saved trimmed and in lowercase.
- `role_id` (string, required): The permission group they join with: an id from `GET /v1/api/store/{team_slug}/setting/group`.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/invite' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "jordan@example.com",
    "role_id": "drvVENtzY33bqP"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your plan's user limit is reached. The body is `{"message": "Plan only allows a maximum of N users"}`, without the error envelope. Fix: Remove a member or an invitation, or upgrade the plan.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
  - When: `role_id` is not one of your team's permission groups. `error.code` is null; `error.message` names the record type. Fix: Use a group id from the groups list.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `email` or `role_id` is missing or not valid, or the email already has an invitation on this team (`validation_failed`, with `error.fields.email` or `error.fields.role_id`). Fix: Check the email; delete the old invitation before inviting again.
  - When: `error.code` `validation_error`, with `error.message` saying why: "User is already in the team." or "An invitation for this email address is already pending." (an invitation for their account under another address). Fix: Don't invite members; delete the other invitation first.
  - When: The address matches more than one old YoPrint account (`validation_error`). Fix: Contact YoPrint support before inviting it.
- `503`
  - When: The invitation was saved but the email could not be sent: `error.code` `invitation_delivery_failed`. Fix: Don't create it again. Resend it once mail works: `PATCH /v1/api/store/{team_slug}/setting/invite/resend/{invite}`.

## Related

- [List invitations](https://developer.yoprint.com/reference/team-invitations/v1-invite-index.md): `GET /v1/api/store/{team_slug}/setting/invite`
- [Resend an invitation](https://developer.yoprint.com/reference/team-invitations/v1-team-invite-resend.md): `PATCH /v1/api/store/{team_slug}/setting/invite/resend/{invite}`
- [List permission groups](https://developer.yoprint.com/reference/permission-groups/v1-group-index.md): `GET /v1/api/store/{team_slug}/setting/group`