Add users to teams

curl --request POST \
  --url https://app.prophecy.io/api/auth/inviteUsers \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "users": [
    {
      "emailID": "user@example.com",
      "invitationStatus": "Accepted",
      "createUser": false
    }
  ],
  "teams": [
    "analytics_team"
  ],
  "isAdmin": false,
  "seatsRequested": 0,
  "isRequesterGlobalAdmin": false
}
'

{
  "success": true,
  "message": "1 invitations successful.",
  "details": {
    "totalUsers": 1,
    "totalTeams": 1,
    "totalPossibleInvitations": 1,
    "attemptedInvitations": 1,
    "successfulInvitations": 1,
    "userCreationFailures": 0,
    "teamInvitationFailures": 0,
    "skippedInvitations": 0,
    "athenaCallResult": "<RESULT>",
    "emailResult": "<RESULT>",
    "seatsRequested": 0
  }
}

POST

api

auth

inviteUsers

curl --request POST \
  --url https://app.prophecy.io/api/auth/inviteUsers \
  --header 'Content-Type: application/json' \
  --header 'X-AUTH-TOKEN: <x-auth-token>' \
  --data '
{
  "users": [
    {
      "emailID": "user@example.com",
      "invitationStatus": "Accepted",
      "createUser": false
    }
  ],
  "teams": [
    "analytics_team"
  ],
  "isAdmin": false,
  "seatsRequested": 0,
  "isRequesterGlobalAdmin": false
}
'

{
  "success": true,
  "message": "1 invitations successful.",
  "details": {
    "totalUsers": 1,
    "totalTeams": 1,
    "totalPossibleInvitations": 1,
    "attemptedInvitations": 1,
    "successfulInvitations": 1,
    "userCreationFailures": 0,
    "teamInvitationFailures": 0,
    "skippedInvitations": 0,
    "athenaCallResult": "<RESULT>",
    "emailResult": "<RESULT>",
    "seatsRequested": 0
  }
}

Add existing or new users

Choose the request shape based on whether each person already has a Prophecy account:

Person	`createUser`	`invitationStatus`	Result
Already has an account	`false`	`Accepted`	They join the team immediately.
Does not have an account	`true`	Omit	Prophecy creates their account and adds it to the team.

When you create users, isRequesterGlobalAdmin controls what happens next:

`isRequesterGlobalAdmin`	What happens to the new person
`true`	They are invited and can use Prophecy as soon as they sign in.
`false`	The invitation waits until a Prophecy administrator approves it.

Set isRequesterGlobalAdmin to true only if your account is a Prophecy administrator for the whole instance. The get current user API returns ClusterAdmin as the account type in that case. If Prophecy sends email on your instance, new people also get an invitation email. The response’s emailResult says whether one was sent. To confirm that people joined a team, use the get team members query.

Troubleshoot team invitation failures

A response with "success": false and N team invitation failures means that many people were not added. The response does not say why. It is one of these causes:

Cause	Fix
The person has no Prophecy account and `createUser` is `false`.	Invite them with `"createUser": true`.
No team has exactly that name, for example because a team ID was sent.	Use the team’s exact name.
Your account is not an admin of that team.	Ask a team admin to add them, or to make you an admin.
Prophecy could not add the member.	Try again. If it keeps failing, contact Prophecy support.

Invite registration failed in the message is a different error. The account was created, but Prophecy’s seat registration did not accept it. Ask your Prophecy administrator about available seats.

Headers

X-AUTH-TOKEN

string

required

Prophecy access token

Body

application/json

users

object[]

One entry per person.

Show child attributes

teams

string[]

One or more team names (not team IDs).

isAdmin

boolean

true makes the people team admins as well as members.

seatsRequested

integer

Leave as 0 unless your Prophecy administrator gives you a number of seats to request.

isRequesterGlobalAdmin

boolean

Whether your account is a Prophecy administrator for the whole instance (account type ClusterAdmin). When creating users, true means invited people can use Prophecy as soon as they sign in, and false means the invitation waits until a Prophecy administrator approves it. Leave as false when adding people who already have an account.

Response

200 - application/json

Invitation results

success

boolean

Indicates whether all invitations succeeded.

message

string

Summary of the outcome, for example 1 invitations successful. or N team invitation failures.

details

object

Show child attributes

API documentation

Endpoints

Add existing or new users

Troubleshoot team invitation failures

Headers

Body

Response

​Add existing or new users

​Troubleshoot team invitation failures

Headers

Body

Response

Add existing or new users

Troubleshoot team invitation failures