Skip to content
PrefactorPrefactorPrefactor Docs

Create a new admin user invite

POST
/api/v1/admin_user_invite
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

Section titled “Authorizations”

Request Body

Section titled “Request Body”
AdminUserInvite_DetailsForCreate
object
account_id
One of:
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ns6jadrqmpgrjkeny
email

Email address to send the invite to

string
Example
user@example.com

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
details
required
AdminUserInvite_Details
object
account_id
required
Account_Id

A valid account ID

string
email
required

Email address the invite was sent to

string
id
required
AdminUserInvite_Id

A valid admin user invite ID

string
inserted_at
required

When the invite was created

string format: date-time
invite_url
required
Uri

URL to accept the invite

string format: uri
status
required

Current status of the invite

string
Allowed values: pending used revoked
token
required

Unique token for the invite

string
type
required

Type of resource (always ‘admin_user_invite’)

string
Allowed values: admin_user_invite
updated_at
required

When the invite was last updated

string format: date-time
status
required
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

Section titled “default”

Error

Media typeapplication/json
One of:
object
code
required
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 temporarily_unavailable conflict
message
required
string
status
required
string
Allowed values: error
Example
{
  "code": "bad_request",
  "status": "error"
}