Create Organization Invitations

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

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

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

Request

This endpoint expects an object.

emailslist of stringsRequired

One or more email addresses to invite

organizationRoleIdstringOptionalformat: "uuid"

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

Response

successboolean

Indicates if the request was successful

dataobject

Headers

Request

Response