Invite User

Send one or more platform user invitations.

POST

/api/v1/users/invite

Description

Invites users to your Unduit company account. Send a single invite via email/role/country or invites array.

Request

Headers

Header	Value	Required
Authorization	Bearer <access_token>	Yes
Content-Type	application/json	Yes

Body Parameters

Parameter	Type	Required	Description
invites	array	No	Array of invite objects (preferred for multiple).
email	string	No	Single invite email (alternative to invites[]).
role	number	No	Corporate role for single invite: 1, 2, or 3.
country	string	No	Country code for single invite.
message	string	No	Custom invitation email message.
app_type	number	No	Application type (default 2).
cc_email	string	No	CC on invitation email.
bcc_email	string	No	BCC on invitation email.

Each object in invites[]

Required when using the invites array format.

Fields

Parameter	Type	Required	Description
email	string	Yes	Invitee email.
role	number	Yes	1=Department head, 2=Manager, 3=Requester.
country	string	Yes	Country code.

Example Request Body

{
  "invites": [
    {
      "email": "new.user@example.com",
      "role": 3,
      "country": "US"
    }
  ],
  "message": "Welcome to our Unduit workspace",
  "app_type": 2
}

Response

Field	Type	Description
success	boolean	Whether the request succeeded.
message	string	Human-readable result message.
added_emails	array	Emails for newly created invitations.
updated_emails	array	Emails for re-sent pending invitations.
skipped_registered_emails	array	Emails skipped because the user is already registered.
invites	array	Created or updated invitation objects.
invites[].invite_id	string	Opaque invitation record ID.
invites[].email	string	Invitee email.
invites[].role	number	Corporate role (1, 2, or 3).
invites[].role_name	string	Human-readable role label.
invites[].country	string	Country code.
invites[].status	number	Invite status (0=Pending).
invites[].status_name	string	Pending or Accepted.
invites[].token	string	Invitation token (internal use).
invites[].email_sent	boolean	Whether the invitation email was sent.

Notes

Returns HTTP 201 on success.

Related Endpoints

Resend Invite

Resend a pending invitation

Did this page help you?

curl -X POST https://uat.unduit.com/api-exposed/api/v1/users/invite \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{ "invites": [ { "email": "new.user@example.com", "role": 3, "country": "US" } ], "message": "Welcome to our Unduit workspace", "app_type": 2 }'

{ "success": true, "message": "Invitation successfully sent", "added_emails": ["new.user@example.com"], "updated_emails": [], "skipped_registered_emails": [], "invites": [ { "invite_id": "1830751-15", "email": "new.user@example.com", "role": 3, "role_name": "Requester", "country": "US", "status": 0, "status_name": "Pending", "token": "m1abc2def3ghi", "email_sent": true } ] }

Invite User

Description

Request

Headers

Body Parameters

Each object in invites[]

Fields

Example Request Body

Response

Notes

Related Endpoints

Resend Invite

Request

Success Response

Error Responses

422 Validation Error