API ReferenceRev Users

Create Rev User

Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

descriptionstringOptionalformat: "text"
Description of the Rev user.
display_namestringOptionalformat: "text"

The user’s display name. The name is non-unique and mutable.

display_picturestringOptionalformat: "id"
Artifact ID of a Rev user's display picture.
emailstringOptionalformat: "text"
Email address of the Rev user.
external_refstringOptionalformat: "text"

External ref is a mutable unique identifier for a user within the Dev organization from your primary customer record. If none is available, a good alternative is the email address/phone number which could uniquely identify the user. If none is specified, a system-generated identifier will be assigned to the user.

phone_numberslist of stringsOptional
Phone numbers, in E.164 format, of the Rev user.
rev_orgstringOptionalformat: "id"
The ID of the Rev organization to which the created Rev user is associated.
custom_schema_fragmentslist of stringsOptionalDeprecated
The schema fragment IDs associated with the Rev user.

Response

Response object for creating a new Rev user for Rev organization.
rev_userobject

Errors