Save Company Employee

POST

Save Company Employee

Headers

X-Brightmove-User-ApiKeystringRequired

Request

This endpoint expects an object.

userGklongOptional

guidstringOptional

salutationobjectOptional

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

nicknamestringOptional

emailstringOptional

workEmailstringOptional

typeobjectOptional

companyGklongOptional

companyNamestringOptional

companyGuidstringOptional

createUserGklongOptional

modifyUserGklongOptional

usernamestringOptional

avatarUrlstringOptional

timezoneIdintegerOptional

localeIdintegerOptional

statusIdintegerOptional

phoneslist of objectsOptional

primarybooleanOptional

createUserobjectOptional

modifyUserobjectOptional

createDatedatetimeOptional

modifyDatedatetimeOptional

themeGklongOptional

lookDatedatetimeOptional

unsubscribeDatedatetimeOptional

delegateslist of objectsOptional

emailSignaturestringOptional

employeeGKlongOptional

salesRepbooleanOptional

recruiterbooleanOptional

sourcerbooleanOptional

officeNamestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

stateobjectOptional

citystringOptional

zipstringOptional

countrystringOptional

payrollHourlyRatedoubleOptional

approverbooleanOptional

managerobjectOptional

statusenumOptional

Allowed values: NONEACTIVEINACTIVETOMBSTONE

sendDigestEmailbooleanOptional

ssoDisabledbooleanOptional

enabledTwoFactorbooleanOptional

remoteAtsIdstringOptional

lastAccessdatetimeOptional

officeobjectOptional

employeeIdstringOptional

subordinateslist of objectsOptional

securityRoleslist of objectsOptional

namestringOptional

displayFullNamestringOptional

displayNameLastFirststringOptional

bestEmailstringOptional

displayNamestringOptional

Response

OK

userGklongOptional

guidstringOptional

salutationobjectOptional

firstNamestringOptional

middleNamestringOptional

lastNamestringOptional

nicknamestringOptional

emailstringOptional

workEmailstringOptional

typeobjectOptional

companyGklongOptional

companyNamestringOptional

companyGuidstringOptional

createUserGklongOptional

modifyUserGklongOptional

usernamestringOptional

avatarUrlstringOptional

timezoneIdintegerOptional

localeIdintegerOptional

statusIdintegerOptional

phoneslist of objectsOptional

primarybooleanOptional

createUserobjectOptional

modifyUserobjectOptional

createDatedatetimeOptional

modifyDatedatetimeOptional

themeGklongOptional

lookDatedatetimeOptional

unsubscribeDatedatetimeOptional

delegateslist of objectsOptional

emailSignaturestringOptional

employeeGKlongOptional

salesRepbooleanOptional

recruiterbooleanOptional

sourcerbooleanOptional

officeNamestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

stateobjectOptional

citystringOptional

zipstringOptional

countrystringOptional

payrollHourlyRatedoubleOptional

approverbooleanOptional

managerobjectOptional

statusenumOptional

Allowed values: NONEACTIVEINACTIVETOMBSTONE

sendDigestEmailbooleanOptional

ssoDisabledbooleanOptional

enabledTwoFactorbooleanOptional

remoteAtsIdstringOptional

lastAccessdatetimeOptional

officeobjectOptional

employeeIdstringOptional

subordinateslist of objectsOptional

securityRoleslist of objectsOptional

namestringOptional

displayFullNamestringOptional

displayNameLastFirststringOptional

bestEmailstringOptional

displayNamestringOptional

POST

1 curl -X POST https://app.brightmove.com/ATS/app/employee \
2      -H "Content-Type: application/json" \
3      -d '{}'

200Successful

1 {
2   "userGk": 1000000,
3   "guid": "guid",
4   "salutation": {
5     "id": 1000000,
6     "name": "name"
7   },
8   "firstName": "firstName",
9   "middleName": "middleName",
10   "lastName": "lastName",
11   "nickname": "nickname",
12   "email": "email",
13   "workEmail": "workEmail",
14   "type": {
15     "id": 1,
16     "name": "name"
17   },
18   "companyGk": 1000000,
19   "companyName": "companyName",
20   "companyGuid": "companyGuid",
21   "createUserGk": 1000000,
22   "modifyUserGk": 1000000,
23   "username": "username",
24   "avatarUrl": "avatarUrl",
25   "timezoneId": 1,
26   "localeId": 1,
27   "statusId": 1,
28   "phones": [
29     {
30       "id": 1000000,
31       "phoneNumber": "phoneNumber",
32       "type": {
33         "id": 1000000
34       },
35       "userGk": 1000000
36     }
37   ],
38   "primary": true,
39   "createUser": {
40     "userGk": 1000000,
41     "guid": "guid",
42     "salutation": {
43       "id": 1000000,
44       "name": "name"
45     },
46     "firstName": "firstName",
47     "middleName": "middleName",
48     "lastName": "lastName",
49     "nickname": "nickname",
50     "email": "email",
51     "workEmail": "workEmail",
52     "type": {
53       "id": 1,
54       "name": "name"
55     },
56     "companyGk": 1000000,
57     "companyName": "companyName",
58     "companyGuid": "companyGuid",
59     "createUserGk": 1000000,
60     "modifyUserGk": 1000000,
61     "username": "username",
62     "avatarUrl": "avatarUrl",
63     "timezoneId": 1,
64     "localeId": 1,
65     "statusId": 1,
66     "displayFullName": "displayFullName",
67     "displayNameLastFirst": "displayNameLastFirst",
68     "bestEmail": "bestEmail",
69     "displayName": "displayName"
70   },
71   "modifyUser": {
72     "userGk": 1000000,
73     "guid": "guid",
74     "salutation": {
75       "id": 1000000,
76       "name": "name"
77     },
78     "firstName": "firstName",
79     "middleName": "middleName",
80     "lastName": "lastName",
81     "nickname": "nickname",
82     "email": "email",
83     "workEmail": "workEmail",
84     "type": {
85       "id": 1,
86       "name": "name"
87     },
88     "companyGk": 1000000,
89     "companyName": "companyName",
90     "companyGuid": "companyGuid",
91     "createUserGk": 1000000,
92     "modifyUserGk": 1000000,
93     "username": "username",
94     "avatarUrl": "avatarUrl",
95     "timezoneId": 1,
96     "localeId": 1,
97     "statusId": 1,
98     "displayFullName": "displayFullName",
99     "displayNameLastFirst": "displayNameLastFirst",
100     "bestEmail": "bestEmail",
101     "displayName": "displayName"
102   },
103   "createDate": "2024-01-15T09:30:00Z",
104   "modifyDate": "2024-01-15T09:30:00Z",
105   "themeGk": 1000000,
106   "lookDate": "2024-01-15T09:30:00Z",
107   "unsubscribeDate": "2024-01-15T09:30:00Z",
108   "delegates": [
109     {
110       "userGk": 1000000,
111       "guid": "guid",
112       "salutation": {
113         "id": 1000000
114       },
115       "firstName": "firstName",
116       "middleName": "middleName",
117       "lastName": "lastName",
118       "nickname": "nickname",
119       "email": "email",
120       "workEmail": "workEmail",
121       "companyGk": 1000000,
122       "companyName": "companyName",
123       "companyGuid": "companyGuid",
124       "createUserGk": 1000000,
125       "modifyUserGk": 1000000,
126       "username": "username",
127       "avatarUrl": "avatarUrl",
128       "timezoneId": 1,
129       "localeId": 1,
130       "statusId": 1,
131       "phones": [
132         {}
133       ],
134       "primary": true,
135       "createDate": "2024-01-15T09:30:00Z",
136       "modifyDate": "2024-01-15T09:30:00Z",
137       "themeGk": 1000000,
138       "lookDate": "2024-01-15T09:30:00Z",
139       "unsubscribeDate": "2024-01-15T09:30:00Z",
140       "emailSignature": "emailSignature",
141       "startDate": "2024-01-15T09:30:00Z",
142       "endDate": "2024-01-15T09:30:00Z",
143       "name": "name",
144       "displayFullName": "displayFullName",
145       "displayNameLastFirst": "displayNameLastFirst",
146       "bestEmail": "bestEmail",
147       "displayName": "displayName"
148     }
149   ],
150   "emailSignature": "emailSignature",
151   "employeeGK": 1000000,
152   "salesRep": true,
153   "recruiter": true,
154   "sourcer": true,
155   "officeName": "officeName",
156   "location": {
157     "address1": "address1",
158     "address2": "address2",
159     "city": "city",
160     "state": {
161       "id": 1000000,
162       "name": "name",
163       "country": {
164         "id": 1000000
165       },
166       "abbr": "abbr"
167     },
168     "postalCode": "postalCode",
169     "country": {
170       "id": 1000000,
171       "name": "name",
172       "countryCode": "countryCode"
173     }
174   },
175   "address": "address",
176   "address2": "address2",
177   "state": {
178     "id": 1000000,
179     "name": "name",
180     "country": {
181       "id": 1000000,
182       "name": "name",
183       "countryCode": "countryCode"
184     },
185     "abbr": "abbr"
186   },
187   "city": "city",
188   "zip": "zip",
189   "country": "country",
190   "payrollHourlyRate": 1.1,
191   "approver": true,
192   "manager": {
193     "userGk": 1000000,
194     "guid": "guid",
195     "salutation": {
196       "id": 1000000,
197       "name": "name"
198     },
199     "firstName": "firstName",
200     "middleName": "middleName",
201     "lastName": "lastName",
202     "nickname": "nickname",
203     "email": "email",
204     "workEmail": "workEmail",
205     "type": {
206       "id": 1,
207       "name": "name"
208     },
209     "companyGk": 1000000,
210     "companyName": "companyName",
211     "companyGuid": "companyGuid",
212     "createUserGk": 1000000,
213     "modifyUserGk": 1000000,
214     "username": "username",
215     "avatarUrl": "avatarUrl",
216     "timezoneId": 1,
217     "localeId": 1,
218     "statusId": 1,
219     "phones": [
220       {}
221     ],
222     "primary": true,
223     "createUser": {
224       "userGk": 1000000,
225       "guid": "guid",
226       "salutation": {
227         "id": 1000000
228       },
229       "firstName": "firstName",
230       "middleName": "middleName",
231       "lastName": "lastName",
232       "nickname": "nickname",
233       "email": "email",
234       "workEmail": "workEmail",
235       "companyGk": 1000000,
236       "companyName": "companyName",
237       "companyGuid": "companyGuid",
238       "createUserGk": 1000000,
239       "modifyUserGk": 1000000,
240       "username": "username",
241       "avatarUrl": "avatarUrl",
242       "timezoneId": 1,
243       "localeId": 1,
244       "statusId": 1,
245       "displayFullName": "displayFullName",
246       "displayNameLastFirst": "displayNameLastFirst",
247       "bestEmail": "bestEmail",
248       "displayName": "displayName"
249     },
250     "modifyUser": {
251       "userGk": 1000000,
252       "guid": "guid",
253       "salutation": {
254         "id": 1000000
255       },
256       "firstName": "firstName",
257       "middleName": "middleName",
258       "lastName": "lastName",
259       "nickname": "nickname",
260       "email": "email",
261       "workEmail": "workEmail",
262       "companyGk": 1000000,
263       "companyName": "companyName",
264       "companyGuid": "companyGuid",
265       "createUserGk": 1000000,
266       "modifyUserGk": 1000000,
267       "username": "username",
268       "avatarUrl": "avatarUrl",
269       "timezoneId": 1,
270       "localeId": 1,
271       "statusId": 1,
272       "displayFullName": "displayFullName",
273       "displayNameLastFirst": "displayNameLastFirst",
274       "bestEmail": "bestEmail",
275       "displayName": "displayName"
276     },
277     "createDate": "2024-01-15T09:30:00Z",
278     "modifyDate": "2024-01-15T09:30:00Z",
279     "themeGk": 1000000,
280     "lookDate": "2024-01-15T09:30:00Z",
281     "unsubscribeDate": "2024-01-15T09:30:00Z",
282     "delegates": [
283       {}
284     ],
285     "emailSignature": "emailSignature",
286     "name": "name",
287     "displayFullName": "displayFullName",
288     "displayNameLastFirst": "displayNameLastFirst",
289     "bestEmail": "bestEmail",
290     "displayName": "displayName"
291   },
292   "status": "NONE",
293   "sendDigestEmail": true,
294   "ssoDisabled": true,
295   "enabledTwoFactor": true,
296   "remoteAtsId": "remoteAtsId",
297   "lastAccess": "2024-01-15T09:30:00Z",
298   "office": {
299     "officeGk": 1000000,
300     "guid": "guid",
301     "name": "name",
302     "location": {
303       "address1": "address1",
304       "address2": "address2",
305       "city": "city",
306       "state": {
307         "id": 1000000
308       },
309       "postalCode": "postalCode",
310       "country": {
311         "id": 1000000
312       }
313     },
314     "address": "address",
315     "address2": "address2",
316     "city": "city",
317     "state": {
318       "id": 1000000,
319       "name": "name",
320       "country": {
321         "id": 1000000
322       },
323       "abbr": "abbr"
324     },
325     "postalCode": "postalCode",
326     "phones": [
327       {}
328     ],
329     "createDate": "2024-01-15T09:30:00Z",
330     "modifyDate": "2024-01-15T09:30:00Z",
331     "costCenter": "costCenter",
332     "createUser": {
333       "userGk": 1000000,
334       "guid": "guid",
335       "salutation": {
336         "id": 1000000
337       },
338       "firstName": "firstName",
339       "middleName": "middleName",
340       "lastName": "lastName",
341       "nickname": "nickname",
342       "email": "email",
343       "workEmail": "workEmail",
344       "companyGk": 1000000,
345       "companyName": "companyName",
346       "companyGuid": "companyGuid",
347       "createUserGk": 1000000,
348       "modifyUserGk": 1000000,
349       "username": "username",
350       "avatarUrl": "avatarUrl",
351       "timezoneId": 1,
352       "localeId": 1,
353       "statusId": 1,
354       "displayFullName": "displayFullName",
355       "displayNameLastFirst": "displayNameLastFirst",
356       "bestEmail": "bestEmail",
357       "displayName": "displayName"
358     },
359     "modifyUser": {
360       "userGk": 1000000,
361       "guid": "guid",
362       "salutation": {
363         "id": 1000000
364       },
365       "firstName": "firstName",
366       "middleName": "middleName",
367       "lastName": "lastName",
368       "nickname": "nickname",
369       "email": "email",
370       "workEmail": "workEmail",
371       "companyGk": 1000000,
372       "companyName": "companyName",
373       "companyGuid": "companyGuid",
374       "createUserGk": 1000000,
375       "modifyUserGk": 1000000,
376       "username": "username",
377       "avatarUrl": "avatarUrl",
378       "timezoneId": 1,
379       "localeId": 1,
380       "statusId": 1,
381       "displayFullName": "displayFullName",
382       "displayNameLastFirst": "displayNameLastFirst",
383       "bestEmail": "bestEmail",
384       "displayName": "displayName"
385     },
386     "email": "email",
387     "country": "country"
388   },
389   "employeeId": "employeeId",
390   "subordinates": [
391     {
392       "userGk": 1000000,
393       "guid": "guid",
394       "salutation": {
395         "id": 1000000
396       },
397       "firstName": "firstName",
398       "middleName": "middleName",
399       "lastName": "lastName",
400       "nickname": "nickname",
401       "email": "email",
402       "workEmail": "workEmail",
403       "companyGk": 1000000,
404       "companyName": "companyName",
405       "companyGuid": "companyGuid",
406       "createUserGk": 1000000,
407       "modifyUserGk": 1000000,
408       "username": "username",
409       "avatarUrl": "avatarUrl",
410       "timezoneId": 1,
411       "localeId": 1,
412       "statusId": 1,
413       "phones": [
414         {}
415       ],
416       "primary": true,
417       "createDate": "2024-01-15T09:30:00Z",
418       "modifyDate": "2024-01-15T09:30:00Z",
419       "themeGk": 1000000,
420       "lookDate": "2024-01-15T09:30:00Z",
421       "unsubscribeDate": "2024-01-15T09:30:00Z",
422       "delegates": [
423         {}
424       ],
425       "emailSignature": "emailSignature",
426       "officeName": "officeName",
427       "name": "name",
428       "displayFullName": "displayFullName",
429       "displayNameLastFirst": "displayNameLastFirst",
430       "bestEmail": "bestEmail",
431       "displayName": "displayName"
432     }
433   ],
434   "securityRoles": [
435     {
436       "value": 1000000,
437       "label": "label"
438     }
439   ],
440   "name": "name",
441   "displayFullName": "displayFullName",
442   "displayNameLastFirst": "displayNameLastFirst",
443   "bestEmail": "bestEmail",
444   "displayName": "displayName"
445 }

Delete Company Employee