Create Rev User — DevRev

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

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

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

1 { 2 "rev_user": { 3 "id": "foo", 4 "created_by": { 5 "display_id": "foo", 6 "id": "foo", 7 "display_name": "foo", 8 "display_picture": { 9 "display_id": "foo", 10 "id": "foo", 11 "file": { 12 "type": "foo", 13 "name": "foo", 14 "size": 42 15 } 16 }, 17 "email": "foo", 18 "full_name": "foo", 19 "state": "active" 20 }, 21 "created_date": "2023-01-01T12:00:00.000Z", 22 "description": "foo", 23 "display_id": "foo", 24 "display_name": "foo", 25 "display_picture": { 26 "id": "foo", 27 "display_id": "foo", 28 "file": { 29 "type": "foo", 30 "name": "foo", 31 "size": 42 32 } 33 }, 34 "email": "foo", 35 "external_ref": "foo", 36 "full_name": "foo", 37 "modified_by": { 38 "display_id": "foo", 39 "id": "foo", 40 "display_name": "foo", 41 "display_picture": { 42 "display_id": "foo", 43 "id": "foo", 44 "file": { 45 "type": "foo", 46 "name": "foo", 47 "size": 42 48 } 49 }, 50 "email": "foo", 51 "full_name": "foo", 52 "state": "active" 53 }, 54 "modified_date": "2023-01-01T12:00:00.000Z", 55 "phone_numbers": [ 56 "foo" 57 ], 58 "primary_identity": { 59 "display_id": "foo", 60 "id": "foo", 61 "display_name": "foo", 62 "display_picture": { 63 "display_id": "foo", 64 "id": "foo", 65 "file": { 66 "type": "foo", 67 "name": "foo", 68 "size": 42 69 } 70 }, 71 "email": "foo", 72 "full_name": "foo", 73 "state": "active" 74 }, 75 "rev_org": { 76 "display_id": "foo", 77 "id": "foo", 78 "display_name": "foo" 79 }, 80 "state": "active" 81 } 82 }

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

1	{
2	"rev_user": {
3	"id": "foo",
4	"created_by": {
5	"display_id": "foo",
6	"id": "foo",
7	"display_name": "foo",
8	"display_picture": {
9	"display_id": "foo",
10	"id": "foo",
11	"file": {
12	"type": "foo",
13	"name": "foo",
14	"size": 42
15	}
16	},
17	"email": "foo",
18	"full_name": "foo",
19	"state": "active"
20	},
21	"created_date": "2023-01-01T12:00:00.000Z",
22	"description": "foo",
23	"display_id": "foo",
24	"display_name": "foo",
25	"display_picture": {
26	"id": "foo",
27	"display_id": "foo",
28	"file": {
29	"type": "foo",
30	"name": "foo",
31	"size": 42
32	}
33	},
34	"email": "foo",
35	"external_ref": "foo",
36	"full_name": "foo",
37	"modified_by": {
38	"display_id": "foo",
39	"id": "foo",
40	"display_name": "foo",
41	"display_picture": {
42	"display_id": "foo",
43	"id": "foo",
44	"file": {
45	"type": "foo",
46	"name": "foo",
47	"size": 42
48	}
49	},
50	"email": "foo",
51	"full_name": "foo",
52	"state": "active"
53	},
54	"modified_date": "2023-01-01T12:00:00.000Z",
55	"phone_numbers": [
56	"foo"
57	],
58	"primary_identity": {
59	"display_id": "foo",
60	"id": "foo",
61	"display_name": "foo",
62	"display_picture": {
63	"display_id": "foo",
64	"id": "foo",
65	"file": {
66	"type": "foo",
67	"name": "foo",
68	"size": 42
69	}
70	},
71	"email": "foo",
72	"full_name": "foo",
73	"state": "active"
74	},
75	"rev_org": {
76	"display_id": "foo",
77	"id": "foo",
78	"display_name": "foo"
79	},
80	"state": "active"
81	}
82	}