Update Rev User (Beta) — DevRev

Updates a Rev user.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The ID of Rev user to update.

artifactsobjectOptional

custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_fragmentsobjectOptional

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"

Updated description of the Rev user.

display_namestringOptionalformat: "text"

Updated display name of the Rev user.

display_picturestringOptionalformat: "id"

Artifact ID of a Rev user’s updated display picture.

emailstringOptionalformat: "text"

Updated email address of the Rev user.

external_refstringOptionalformat: "text"

Updated external ref value of the Rev user.

external_refslist of stringsOptional

External 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_numberslist of stringsOptional

The phone numbers, in E.164 format, of the Rev user.

tagslist of objectsOptional

Tags associated with the Rev user.

Response

Updated Rev user object.

rev_userobject

1 curl -X POST https://api.devrev.ai/rev-users.update \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "id": "id" 6 }'

1 { 2 "rev_user": { 3 "id": "id", 4 "artifacts": [ 5 { 6 "id": "id", 7 "display_id": "display_id", 8 "file": { 9 "type": "type", 10 "name": "name", 11 "size": 1 12 } 13 }, 14 { 15 "id": "id", 16 "display_id": "display_id", 17 "file": { 18 "type": "type", 19 "name": "name", 20 "size": 1 21 } 22 } 23 ], 24 "created_by": { 25 "type": "dev_user", 26 "id": "id", 27 "display_id": "display_id", 28 "display_name": "display_name", 29 "display_picture": { 30 "id": "id", 31 "file": {} 32 }, 33 "email": "email", 34 "full_name": "full_name", 35 "state": "active" 36 }, 37 "created_date": "created_date", 38 "custom_fields": {}, 39 "custom_schema_fragments": [ 40 "custom_schema_fragments", 41 "custom_schema_fragments" 42 ], 43 "description": "description", 44 "display_id": "display_id", 45 "display_name": "display_name", 46 "display_picture": { 47 "id": "id", 48 "display_id": "display_id", 49 "file": { 50 "type": "type", 51 "name": "name", 52 "size": 1 53 } 54 }, 55 "email": "email", 56 "external_ref": "external_ref", 57 "external_refs": [ 58 "external_refs", 59 "external_refs" 60 ], 61 "full_name": "full_name", 62 "is_verified": true, 63 "modified_by": { 64 "type": "dev_user", 65 "id": "id", 66 "display_id": "display_id", 67 "display_name": "display_name", 68 "display_picture": { 69 "id": "id", 70 "file": {} 71 }, 72 "email": "email", 73 "full_name": "full_name", 74 "state": "active" 75 }, 76 "modified_date": "modified_date", 77 "phone_numbers": [ 78 "phone_numbers", 79 "phone_numbers" 80 ], 81 "rev_org": { 82 "type": "account", 83 "id": "id", 84 "display_id": "display_id", 85 "display_name": "display_name" 86 }, 87 "state": "active", 88 "stock_schema_fragment": "stock_schema_fragment", 89 "subtype": "subtype", 90 "tags": [ 91 { 92 "tag": { 93 "id": "id", 94 "name": "name", 95 "display_id": "display_id", 96 "style_new": { 97 "color": "color" 98 } 99 }, 100 "value": "value" 101 }, 102 { 103 "tag": { 104 "id": "id", 105 "name": "name", 106 "display_id": "display_id", 107 "style_new": { 108 "color": "color" 109 } 110 }, 111 "value": "value" 112 } 113 ] 114 } 115 }

1	curl -X POST https://api.devrev.ai/rev-users.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "id"
6	}'

1	{
2	"rev_user": {
3	"id": "id",
4	"artifacts": [
5	{
6	"id": "id",
7	"display_id": "display_id",
8	"file": {
9	"type": "type",
10	"name": "name",
11	"size": 1
12	}
13	},
14	{
15	"id": "id",
16	"display_id": "display_id",
17	"file": {
18	"type": "type",
19	"name": "name",
20	"size": 1
21	}
22	}
23	],
24	"created_by": {
25	"type": "dev_user",
26	"id": "id",
27	"display_id": "display_id",
28	"display_name": "display_name",
29	"display_picture": {
30	"id": "id",
31	"file": {}
32	},
33	"email": "email",
34	"full_name": "full_name",
35	"state": "active"
36	},
37	"created_date": "created_date",
38	"custom_fields": {},
39	"custom_schema_fragments": [
40	"custom_schema_fragments",
41	"custom_schema_fragments"
42	],
43	"description": "description",
44	"display_id": "display_id",
45	"display_name": "display_name",
46	"display_picture": {
47	"id": "id",
48	"display_id": "display_id",
49	"file": {
50	"type": "type",
51	"name": "name",
52	"size": 1
53	}
54	},
55	"email": "email",
56	"external_ref": "external_ref",
57	"external_refs": [
58	"external_refs",
59	"external_refs"
60	],
61	"full_name": "full_name",
62	"is_verified": true,
63	"modified_by": {
64	"type": "dev_user",
65	"id": "id",
66	"display_id": "display_id",
67	"display_name": "display_name",
68	"display_picture": {
69	"id": "id",
70	"file": {}
71	},
72	"email": "email",
73	"full_name": "full_name",
74	"state": "active"
75	},
76	"modified_date": "modified_date",
77	"phone_numbers": [
78	"phone_numbers",
79	"phone_numbers"
80	],
81	"rev_org": {
82	"type": "account",
83	"id": "id",
84	"display_id": "display_id",
85	"display_name": "display_name"
86	},
87	"state": "active",
88	"stock_schema_fragment": "stock_schema_fragment",
89	"subtype": "subtype",
90	"tags": [
91	{
92	"tag": {
93	"id": "id",
94	"name": "name",
95	"display_id": "display_id",
96	"style_new": {
97	"color": "color"
98	}
99	},
100	"value": "value"
101	},
102	{
103	"tag": {
104	"id": "id",
105	"name": "name",
106	"display_id": "display_id",
107	"style_new": {
108	"color": "color"
109	}
110	},
111	"value": "value"
112	}
113	]
114	}
115	}