PEpeec
Project

Invite Project Members

Changed on

Invite people to the project by email, as a viewer or an owner. Each person gets the same invitation email as an invite from the app. An email that already has a Peec account gets access right away; anyone else gets access once they sign up from the email. An email that already has access or an open invitation lands in skipped, and the request never fails as a whole because of one item. Returns 403 when the company has turned off email invitations.

post/members/invite

Request

  • Base URL
    https://api.peec.ai/customer/v1
  • URL
    https://api.peec.ai/customer/v1/members/invite
  • Auth
    • API key in header X-API-Key
    • or API key in query parameter api_key
    • or HTTP bearer

Request body

project_idstring

Required if using a company api key

Example request

{
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "members": [
    {
      "email": "jane.doe@example.com",
      "role": "VIEWER"
    }
  ]
}

Response

Per-item results, index naming the position in the request.

Example response

{
  "invited": [
    {
      "role": "VIEWER"
    }
  ]
}

Changes