Create Project Invitations | Confident AI Docs

curl -X POST https://api.confident-ai.com/v1/projects/projectId/invitations \
     -H "CONFIDENT_API_KEY: <ORGANIZATION-API-KEY>" \
     -H "Content-Type: application/json" \
     -d '{
  "emails": [
    "carol@example.com",
    "dave@example.com"
  ],
  "projectRoleId": "project-role-uuid-2"
}'

{
  "success": true,
  "data": {
    "invitations": [
      {
        "id": 201,
        "email": "carol@example.com",
        "status": "PENDING",
        "created_at": "2024-12-04T23:00:00.000Z",
        "projectRoleId": "project-role-uuid-2"
      },
      {
        "id": 202,
        "email": "dave@example.com",
        "status": "PENDING",
        "created_at": "2024-12-04T23:00:00.000Z",
        "projectRoleId": "project-role-uuid-2"
      }
    ]
  }
}

Invites one or more users to a project by email. Emails that are already members or already invited are skipped. Optionally assign a project role to the invitees — the Owner role cannot be assigned. Inviting members is not available on the Free plan outside of the trial period.

Path parameters

projectIdstringRequired

The unique identifier of the project.

Request

This endpoint expects an object.

emailslist of stringsRequired

One or more email addresses to invite

projectRoleIdstringOptionalformat: "uuid"

Optional project role id to assign to all invitees. The Owner role cannot be assigned.

Response

successboolean

Indicates if the request was successful

dataobject

Path parameters

Headers

Request

Response