Create a new admin user invite

POST

/api/v1/admin_user_invite

const url = 'https://app.prefactorai.com/api/v1/admin_user_invite';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"account_id":"013xrzp12g3nqk8ns6jadrqmpgrjkeny","email":"user@example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.prefactorai.com/api/v1/admin_user_invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny", "email": "user@example.com" }'

Authorizations

authorization

Request Body

AdminUserInvite_DetailsForCreate

object

account_id

One of:

Account_Id
Null

Account_Id

A valid account ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

email

Email address to send the invite to

string

Example

user@example.com

Responses

200

Success

application/json

object

details

AdminUserInvite_Details

object

account_id

Account_Id

A valid account ID

string

email

Email address the invite was sent to

string

AdminUserInvite_Id

A valid admin user invite ID

string

inserted_at

When the invite was created

string format: date-time

invite_url

Uri

URL to accept the invite

string format: uri

status

Current status of the invite

string

Allowed values: pending used revoked

token

Unique token for the invite

string

type

Type of resource (always ‘admin_user_invite’)

string

Allowed values: admin_user_invite

updated_at

When the invite was last updated

string format: date-time

status

string

Allowed values: success

Example

{
  "details": {
    "account_id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "email": "user@example.com",
    "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
    "inserted_at": "2024-01-01T00:00:00Z",
    "invite_url": "https://example.com",
    "status": "pending",
    "token": "abc123def456...",
    "type": "admin_user_invite",
    "updated_at": "2024-01-01T00:00:00Z"
  },
  "status": "success"
}

default

Error

application/json

One of:

object
object

object

code

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used

message

string

status

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}