---
title: "Invite collaborators to project"
method: POST
path: "/project/{id}/invite"
tags: ["projects"]
---

# Invite collaborators to project

`POST /project/{id}/invite`

## Request

- Base URL: `https://api.faable.com`
- URL: `https://api.faable.com/project/{id}/invite`
- Auth: one of:
  - OAuth 2 (authorization code, authorization URL `https://faable.auth.faable.link/authorize`, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - OAuth 2 (client credentials, token URL `https://faable.auth.faable.link/oauth/token`)
  - HTTP bearer
  - HTTP basic
  - API key in query parameter `apikey`

Invite collaborators to project

## Path parameters

- `id` string, required

## Request body

- ProjectInvite
  - `emails` string[], required
  - `role` union
    - 'owner'
    - 'member'
    - 'viewer'

## Response `200`

Default Response

- ProjectInviteResult
  - `project` Project, required: Project
    - `id` string, required: Project ID
    - `name` string, required
    - `description` string, required
    - `slug` string, required
    - `team` string, required
    - `user_id` string
    - `collaborators` string[], required
    - `members` object[]
      - `user_id` string, required
      - `role` string, required
    - `product_intent` union
      - 'deploy'
      - 'auth'
      - 'undecided'
    - `owner_suspended` boolean
    - `owner_email` string
    - `organization` string, nullable
    - `createdAt` string, required: Project creation date
    - `updatedAt` string: Project updated date
  - `results` object[], required
    - `email` string, required
    - `status` union, required
      - 'invited'
      - 'invited_created_account'
      - 'already_member'
      - 'failed'
      - 'pending'
    - `user_id` string
    - `error_code` string

## Other responses

- `400`: `validation_error` — The body, query or path failed schema validation. `details.issues` lists each failing field.
- `401`: `unauthorized` — The request carries no valid credentials. `invalid_token` — The bearer token is missing, malformed or expired.
- `403`: `forbidden` — The credentials are valid but do not allow this operation. `user_suspended` — The account is suspended. Contact support@faable.com.
- `404`: `project_not_found` — No project with that id for this caller.
- `429`: `too_many_requests` — Rate limit exceeded. Honour the `Retry-After` header.
- `500`: `internal_error` — Unexpected server error. Retry later; the request id is logged.
- `503`: `database_unavailable` — Faable cannot reach its database right now. Transient: retry after the `Retry-After` header.

---

[API](https://skmtc.dev/faable/apis/faablecloud-api.md) · [All operations](https://skmtc.dev/faable/apis/faablecloud-api/llms.txt) · [OpenAPI document](https://skmtc.dev/faable/apis/faablecloud-api/revisions/e2fc93da3c49?raw)