Create a user invite

post

https://api.ramp.com/developer/v1/users/deferred

Call this endpoint to trigger an async task to send out a user invite.

Body Params

department_id

uuid

Unique identifier of the employee's department

direct_manager_id

uuid

Unique identifier of the employee's direct manager

string

required

The employee's email address

first_name

string

required

length ≤ 255

First name of the employee

idempotency_key

string

an idempotency key is a unique value generated by the client which the server uses to recognize subsequent retries of the same request. To avoid collisions, we encourage clients to use random generated UUIDs.

last_name

string

required

length ≤ 255

Last name of the employee

location_id

uuid

Unique identifier of the employee's location

role

string

enum

required

The employee's role; It could be one of the following values: Admin, Cardholder, Bookkeeper; Note that Owner is not a invitable role.

Allowed:

Response

201Response with the ID of the async task. Task status can be checked via a GET call to .../deferred/status/<task_id>