Create Rev User
Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
The ID of the account to which the created Rev user is associated.
idThe IDs of the artifacts to associate with the Rev user.
Application-defined custom fields.
Empty Object
The schema fragment IDs associated with the Rev user.
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.
Description of the Rev user.
textThe user's display name. The name is non-unique and mutable.
textArtifact ID of a Rev user's display picture.
idEmail address of the Rev user.
textExternal 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.
textExternal refs are mutable unique identifiers for a contact record. If none are available, a good alternative is the email address(es)/phone number(s) which could uniquely identify the contact. If no identifier is specified, a system-generated identifier will be assigned to the contact. For organizations with multi-association contacts support enabled, this field accepts multiple identifiers, where each identifier must be unique across your DevOrg. For organizations without multi-association contacts support, this field accepts a single identifier, maintaining functionality consistent with the existing external_uid field.
Phone numbers, in E.164 format, of the Rev user.
The ID of the Rev organization to which the created Rev user is associated.
idTags associated with the Rev user.
Response Body
curl -X POST "https://api.devrev.ai/rev-users.create" \ -H "Content-Type: application/json" \ -d '{}'{
"rev_user": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"phone_numbers": [
"string"
],
"primary_identity": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"state": "active",
"artifacts": [
{
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
}
],
"custom_fields": {},
"custom_schema_fragments": [
"don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
],
"description": "string",
"external_ref": "string",
"external_refs": [
"string"
],
"is_verified": true,
"rev_org": {
"type": "account",
"display_id": "string",
"id": "string",
"display_name": "string"
},
"stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
"subtype": "string",
"tags": [
{
"tag": {
"display_id": "string",
"id": "string",
"name": "string",
"style_new": {
"color": "string"
}
},
"value": "string"
}
]
}
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "conflict"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}