Update Rev User (Beta) — DevRev

Updates a Rev user.

Request

This endpoint expects an object.

artifactsobjectRequired

custom_schema_fragmentsobjectRequired

custom_schema_specobjectRequired

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.

idstringRequiredformat: "id"

The ID of Rev user to update.

custom_fieldsobjectOptional

Application-defined custom fields.

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 "artifacts": {}, 6 "custom_schema_fragments": {}, 7 "custom_schema_spec": {}, 8 "id": "id" 9 }'

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

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	"artifacts": {},
6	"custom_schema_fragments": {},
7	"custom_schema_spec": {},
8	"id": "id"
9	}'

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