Users

Invite a user, or add an existing SoloFire user to this company

Requires the people.write scope.

post/users

Request

  • Base URL: https://developer.solofire.com/v1
  • URL: https://developer.solofire.com/v1/users
  • Auth: HTTP bearer

Query parameters

rolestring

Filter by company role.

statusstring

Filter by membership status, e.g. active or deactivated.

qstring

Case-insensitive match on email, first name or last name.

limitinteger

Page size, 1 to 200. Defaults to 50.

cursorstring

The next_cursor from a previous response.

Headers

Idempotency-Keystring

A unique key for this request. Retrying with the same key returns the original response instead of repeating the work. Reusing a key with a different body is rejected with 422.

Request body

emailstring required

Email address. If it already belongs to a SoloFire user they are added directly, with no invite email.

first_namestring

Given name.

last_namestring

Family name.

rolestring

One of user, contributor, manager, admin. Defaults to user. Granting admin or manager requires an admin-bound credential.

send_emailboolean

Send the branded invite email. Defaults to true.

Response

Created

object required

Changes

No recorded changes to this operation across all 1 revision of this API.