Create Account (Beta) — DevRev

Creates an account, which is a record representing a customer or an organization.

Request

This endpoint expects an object.

custom_schema_specobjectRequired

Requested custom schemas described abstractly. Every provided schema’s custom field must be specified, otherwise a bad request error is returned. If a new custom schema specifier is provided, then it will be added to the work, otherwise if a custom schema is omitted from the specifier, it remains unmodified.

display_namestringRequiredformat: "text"

Name of the account.

artifactslist of stringsOptional

The IDs of the artifacts to associate with the account.

custom_fieldsobjectOptional

Application-defined custom fields.

descriptionstringOptionalformat: "text"

Description of the account.

domainslist of stringsOptional

List of company’s domain names. Example - [‘devrev.ai’].

external_refslist of stringsOptional

External refs are unique identifiers from your customer system of records, stored as a list.

owned_bylist of stringsOptional

List of Dev users owning this account.

tagslist of objectsOptional

Tags associated with the account.

tierstringOptionalformat: "text"

The tier of the account.

websiteslist of stringsOptional

List of company websites. Example - [‘www.devrev.ai’, ‘www.marketplace.devrev.ai’].

schema_fragment_idslist of stringsOptionalDeprecated

Schema fragment IDs associated with this account SOR.

Response

The response to creating a new account.

accountobject

default_rev_orgobject

1 curl -X POST https://api.devrev.ai/accounts.create \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "custom_schema_spec": {}, 6 "display_name": "display_name" 7 }'

1 { 2 "account": { 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 "id": "id", 21 "modified_by": { 22 "type": "dev_user", 23 "display_picture": { 24 "file": { 25 "type": "type", 26 "name": "name" 27 }, 28 "id": "id", 29 "display_id": "display_id" 30 }, 31 "id": "id", 32 "state": "active", 33 "display_id": "display_id", 34 "display_name": "display_name", 35 "email": "email", 36 "full_name": "full_name" 37 }, 38 "owned_by": [ 39 { 40 "type": "dev_user", 41 "display_picture": { 42 "file": { 43 "type": "type", 44 "name": "name" 45 }, 46 "id": "id", 47 "display_id": "display_id" 48 }, 49 "id": "id", 50 "state": "active", 51 "display_id": "display_id", 52 "display_name": "display_name", 53 "email": "email", 54 "full_name": "full_name" 55 }, 56 { 57 "type": "dev_user", 58 "display_picture": { 59 "file": { 60 "type": "type", 61 "name": "name" 62 }, 63 "id": "id", 64 "display_id": "display_id" 65 }, 66 "id": "id", 67 "state": "active", 68 "display_id": "display_id", 69 "display_name": "display_name", 70 "email": "email", 71 "full_name": "full_name" 72 } 73 ], 74 "artifacts": [ 75 { 76 "file": { 77 "type": "type", 78 "name": "name" 79 }, 80 "id": "id", 81 "display_id": "display_id" 82 }, 83 { 84 "file": { 85 "type": "type", 86 "name": "name" 87 }, 88 "id": "id", 89 "display_id": "display_id" 90 } 91 ], 92 "created_date": "created_date", 93 "custom_fields": {}, 94 "custom_schema_fragments": [ 95 "custom_schema_fragments", 96 "custom_schema_fragments" 97 ], 98 "description": "description", 99 "display_id": "display_id", 100 "display_name": "display_name", 101 "domains": [ 102 "domains", 103 "domains" 104 ], 105 "external_refs": [ 106 "external_refs", 107 "external_refs" 108 ], 109 "modified_date": "modified_date", 110 "stock_schema_fragment": "stock_schema_fragment", 111 "subtype": "subtype", 112 "tags": [ 113 { 114 "tag": { 115 "id": "id", 116 "name": "name", 117 "style_new": { 118 "color": "color" 119 }, 120 "display_id": "display_id" 121 }, 122 "value": "value" 123 }, 124 { 125 "tag": { 126 "id": "id", 127 "name": "name", 128 "style_new": { 129 "color": "color" 130 }, 131 "display_id": "display_id" 132 }, 133 "value": "value" 134 } 135 ], 136 "tier": "tier", 137 "websites": [ 138 "websites", 139 "websites" 140 ] 141 }, 142 "default_rev_org": { 143 "account": { 144 "id": "id", 145 "display_id": "display_id", 146 "display_name": "display_name" 147 }, 148 "created_by": { 149 "type": "dev_user", 150 "display_picture": { 151 "file": { 152 "type": "type", 153 "name": "name" 154 }, 155 "id": "id", 156 "display_id": "display_id" 157 }, 158 "id": "id", 159 "state": "active", 160 "display_id": "display_id", 161 "display_name": "display_name", 162 "email": "email", 163 "full_name": "full_name" 164 }, 165 "id": "id", 166 "modified_by": { 167 "type": "dev_user", 168 "display_picture": { 169 "file": { 170 "type": "type", 171 "name": "name" 172 }, 173 "id": "id", 174 "display_id": "display_id" 175 }, 176 "id": "id", 177 "state": "active", 178 "display_id": "display_id", 179 "display_name": "display_name", 180 "email": "email", 181 "full_name": "full_name" 182 }, 183 "artifacts": [ 184 { 185 "file": { 186 "type": "type", 187 "name": "name" 188 }, 189 "id": "id", 190 "display_id": "display_id" 191 }, 192 { 193 "file": { 194 "type": "type", 195 "name": "name" 196 }, 197 "id": "id", 198 "display_id": "display_id" 199 } 200 ], 201 "created_date": "created_date", 202 "custom_fields": {}, 203 "custom_schema_fragments": [ 204 "custom_schema_fragments", 205 "custom_schema_fragments" 206 ], 207 "description": "description", 208 "display_id": "display_id", 209 "display_name": "display_name", 210 "domain": "domain", 211 "external_ref": "external_ref", 212 "modified_date": "modified_date", 213 "stock_schema_fragment": "stock_schema_fragment", 214 "subtype": "subtype", 215 "tags": [ 216 { 217 "tag": { 218 "id": "id", 219 "name": "name", 220 "style_new": { 221 "color": "color" 222 }, 223 "display_id": "display_id" 224 }, 225 "value": "value" 226 }, 227 { 228 "tag": { 229 "id": "id", 230 "name": "name", 231 "style_new": { 232 "color": "color" 233 }, 234 "display_id": "display_id" 235 }, 236 "value": "value" 237 } 238 ] 239 } 240 }

1	curl -X POST https://api.devrev.ai/accounts.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"custom_schema_spec": {},
6	"display_name": "display_name"
7	}'

1	{
2	"account": {
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	"id": "id",
21	"modified_by": {
22	"type": "dev_user",
23	"display_picture": {
24	"file": {
25	"type": "type",
26	"name": "name"
27	},
28	"id": "id",
29	"display_id": "display_id"
30	},
31	"id": "id",
32	"state": "active",
33	"display_id": "display_id",
34	"display_name": "display_name",
35	"email": "email",
36	"full_name": "full_name"
37	},
38	"owned_by": [
39	{
40	"type": "dev_user",
41	"display_picture": {
42	"file": {
43	"type": "type",
44	"name": "name"
45	},
46	"id": "id",
47	"display_id": "display_id"
48	},
49	"id": "id",
50	"state": "active",
51	"display_id": "display_id",
52	"display_name": "display_name",
53	"email": "email",
54	"full_name": "full_name"
55	},
56	{
57	"type": "dev_user",
58	"display_picture": {
59	"file": {
60	"type": "type",
61	"name": "name"
62	},
63	"id": "id",
64	"display_id": "display_id"
65	},
66	"id": "id",
67	"state": "active",
68	"display_id": "display_id",
69	"display_name": "display_name",
70	"email": "email",
71	"full_name": "full_name"
72	}
73	],
74	"artifacts": [
75	{
76	"file": {
77	"type": "type",
78	"name": "name"
79	},
80	"id": "id",
81	"display_id": "display_id"
82	},
83	{
84	"file": {
85	"type": "type",
86	"name": "name"
87	},
88	"id": "id",
89	"display_id": "display_id"
90	}
91	],
92	"created_date": "created_date",
93	"custom_fields": {},
94	"custom_schema_fragments": [
95	"custom_schema_fragments",
96	"custom_schema_fragments"
97	],
98	"description": "description",
99	"display_id": "display_id",
100	"display_name": "display_name",
101	"domains": [
102	"domains",
103	"domains"
104	],
105	"external_refs": [
106	"external_refs",
107	"external_refs"
108	],
109	"modified_date": "modified_date",
110	"stock_schema_fragment": "stock_schema_fragment",
111	"subtype": "subtype",
112	"tags": [
113	{
114	"tag": {
115	"id": "id",
116	"name": "name",
117	"style_new": {
118	"color": "color"
119	},
120	"display_id": "display_id"
121	},
122	"value": "value"
123	},
124	{
125	"tag": {
126	"id": "id",
127	"name": "name",
128	"style_new": {
129	"color": "color"
130	},
131	"display_id": "display_id"
132	},
133	"value": "value"
134	}
135	],
136	"tier": "tier",
137	"websites": [
138	"websites",
139	"websites"
140	]
141	},
142	"default_rev_org": {
143	"account": {
144	"id": "id",
145	"display_id": "display_id",
146	"display_name": "display_name"
147	},
148	"created_by": {
149	"type": "dev_user",
150	"display_picture": {
151	"file": {
152	"type": "type",
153	"name": "name"
154	},
155	"id": "id",
156	"display_id": "display_id"
157	},
158	"id": "id",
159	"state": "active",
160	"display_id": "display_id",
161	"display_name": "display_name",
162	"email": "email",
163	"full_name": "full_name"
164	},
165	"id": "id",
166	"modified_by": {
167	"type": "dev_user",
168	"display_picture": {
169	"file": {
170	"type": "type",
171	"name": "name"
172	},
173	"id": "id",
174	"display_id": "display_id"
175	},
176	"id": "id",
177	"state": "active",
178	"display_id": "display_id",
179	"display_name": "display_name",
180	"email": "email",
181	"full_name": "full_name"
182	},
183	"artifacts": [
184	{
185	"file": {
186	"type": "type",
187	"name": "name"
188	},
189	"id": "id",
190	"display_id": "display_id"
191	},
192	{
193	"file": {
194	"type": "type",
195	"name": "name"
196	},
197	"id": "id",
198	"display_id": "display_id"
199	}
200	],
201	"created_date": "created_date",
202	"custom_fields": {},
203	"custom_schema_fragments": [
204	"custom_schema_fragments",
205	"custom_schema_fragments"
206	],
207	"description": "description",
208	"display_id": "display_id",
209	"display_name": "display_name",
210	"domain": "domain",
211	"external_ref": "external_ref",
212	"modified_date": "modified_date",
213	"stock_schema_fragment": "stock_schema_fragment",
214	"subtype": "subtype",
215	"tags": [
216	{
217	"tag": {
218	"id": "id",
219	"name": "name",
220	"style_new": {
221	"color": "color"
222	},
223	"display_id": "display_id"
224	},
225	"value": "value"
226	},
227	{
228	"tag": {
229	"id": "id",
230	"name": "name",
231	"style_new": {
232	"color": "color"
233	},
234	"display_id": "display_id"
235	},
236	"value": "value"
237	}
238	]
239	}
240	}