rev-users

Update

POST
Updates a Rev user.

Request

This endpoint expects an object.
id
stringRequired
The ID of Rev user to update.
artifacts
objectOptional
custom_fields
map from strings to anyOptional
Application-defined custom fields.
custom_schema_fragments
objectOptional
description
stringOptional
Updated description of the Rev user.
display_name
stringOptional
Updated display name of the Rev user.
email
stringOptional
Updated email address of the Rev user.
external_ref
stringOptional
Updated external ref value of the Rev user.
phone_numbers
list of stringsOptional
The phone numbers, in E.164 format, of the Rev user.
tags
list of objectsOptional
Tags associated with the Rev user.

Response

This endpoint returns an object
rev_user
object
POST
1curl -X POST https://api.devrev.ai/rev-users.update \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "id": "id"
6}'
200Successful
1{
2 "rev_user": {
3 "id": "id",
4 "artifacts": [
5 {
6 "id": "id"
7 }
8 ],
9 "created_date": "2023-01-01T12:00:00Z",
10 "custom_fields": {
11 "custom_fields": {
12 "key": "value"
13 }
14 },
15 "custom_schema_fragments": [
16 "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
17 ],
18 "description": "description",
19 "display_id": "display_id",
20 "display_name": "display_name",
21 "display_picture": {
22 "id": "id",
23 "display_id": "display_id"
24 },
25 "email": "email",
26 "external_ref": "external_ref",
27 "full_name": "full_name",
28 "is_verified": true,
29 "modified_date": "2023-01-01T12:00:00Z",
30 "phone_numbers": [
31 "phone_numbers"
32 ],
33 "state": "active",
34 "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
35 "subtype": "subtype",
36 "tags": [
37 {
38 "tag": {
39 "id": "id",
40 "name": "name"
41 }
42 }
43 ]
44 }
45}