Save an Office

POST

Save or Update an Office

Headers

X-Brightmove-User-ApiKeystringRequired

X-Brightmove-Company-ApiKeystringOptional

Request

This endpoint expects an object.

officeGklongOptional

guidstringOptional

namestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

citystringOptional

stateobjectOptional

postalCodestringOptional

phoneslist of objectsOptional

clientobjectOptional

The Client object to save.

createDatedatetimeOptional

modifyDatedatetimeOptional

createUserobjectOptional

modifyUserobjectOptional

primarySalesUserobjectOptional

primarybooleanOptional

statusIdintegerOptional

customerobjectOptional

accountNamestringOptional

backOfficeTermobjectOptional

additionSalesUserslist of objectsOptional

udfSectionslist of objectsOptional

Response

OK

officeGklongOptional

guidstringOptional

namestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

citystringOptional

stateobjectOptional

postalCodestringOptional

phoneslist of objectsOptional

clientobjectOptional

The Client object to save.

createDatedatetimeOptional

modifyDatedatetimeOptional

createUserobjectOptional

modifyUserobjectOptional

primarySalesUserobjectOptional

primarybooleanOptional

statusIdintegerOptional

customerobjectOptional

accountNamestringOptional

backOfficeTermobjectOptional

additionSalesUserslist of objectsOptional

udfSectionslist of objectsOptional

POST

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

200Successful

1 {
2   "officeGk": 1000000,
3   "guid": "guid",
4   "name": "name",
5   "location": {
6     "address1": "address1",
7     "address2": "address2",
8     "city": "city",
9     "state": {
10       "id": 1000000,
11       "name": "name",
12       "country": {
13         "id": 1000000
14       },
15       "abbr": "abbr"
16     },
17     "postalCode": "postalCode",
18     "country": {
19       "id": 1000000,
20       "name": "name",
21       "countryCode": "countryCode"
22     }
23   },
24   "address": "address",
25   "address2": "address2",
26   "city": "city",
27   "state": {
28     "id": 1000000,
29     "name": "name",
30     "country": {
31       "id": 1000000,
32       "name": "name",
33       "countryCode": "countryCode"
34     },
35     "abbr": "abbr"
36   },
37   "postalCode": "postalCode",
38   "phones": [
39     {
40       "id": 1000000,
41       "type": {
42         "id": 1000000
43       },
44       "phoneNumber": "phoneNumber",
45       "entityGk": 1000000
46     }
47   ],
48   "client": {
49     "guid": "guid",
50     "statusId": 1,
51     "clientGk": 1000000,
52     "companyName": "companyName",
53     "website": "website",
54     "billAddress1": "billAddress1",
55     "billAddress2": "billAddress2",
56     "billCity": "billCity",
57     "billState": {
58       "id": 1000000,
59       "name": "name",
60       "country": {
61         "id": 1000000
62       },
63       "abbr": "abbr"
64     },
65     "billCountry": "billCountry",
66     "billPostalCode": "billPostalCode",
67     "discountPercentage": 1.1,
68     "discountFee": 1.1,
69     "companyGk": 1000000,
70     "stockSymbol": "stockSymbol",
71     "companyInfo": "companyInfo",
72     "workgroup": {
73       "id": 1000000,
74       "name": "name",
75       "createDate": "2024-01-15T09:30:00Z",
76       "assignedMembers": [
77         {}
78       ]
79     },
80     "createDate": "2024-01-15T09:30:00Z",
81     "modifyDate": "2024-01-15T09:30:00Z",
82     "createUser": {
83       "userGk": 1000000,
84       "guid": "guid",
85       "salutation": {
86         "id": 1000000
87       },
88       "firstName": "firstName",
89       "middleName": "middleName",
90       "lastName": "lastName",
91       "nickname": "nickname",
92       "email": "email",
93       "workEmail": "workEmail",
94       "companyGk": 1000000,
95       "companyName": "companyName",
96       "companyGuid": "companyGuid",
97       "createUserGk": 1000000,
98       "modifyUserGk": 1000000,
99       "username": "username",
100       "avatarUrl": "avatarUrl",
101       "timezoneId": 1,
102       "localeId": 1,
103       "statusId": 1,
104       "phones": [
105         {}
106       ],
107       "primary": true,
108       "createDate": "2024-01-15T09:30:00Z",
109       "modifyDate": "2024-01-15T09:30:00Z",
110       "themeGk": 1000000,
111       "lookDate": "2024-01-15T09:30:00Z",
112       "unsubscribeDate": "2024-01-15T09:30:00Z",
113       "delegates": [
114         {}
115       ],
116       "emailSignature": "emailSignature",
117       "name": "name",
118       "displayName": "displayName",
119       "displayNameLastFirst": "displayNameLastFirst",
120       "bestEmail": "bestEmail",
121       "displayFullName": "displayFullName"
122     },
123     "modifyUser": {
124       "userGk": 1000000,
125       "guid": "guid",
126       "salutation": {
127         "id": 1000000
128       },
129       "firstName": "firstName",
130       "middleName": "middleName",
131       "lastName": "lastName",
132       "nickname": "nickname",
133       "email": "email",
134       "workEmail": "workEmail",
135       "companyGk": 1000000,
136       "companyName": "companyName",
137       "companyGuid": "companyGuid",
138       "createUserGk": 1000000,
139       "modifyUserGk": 1000000,
140       "username": "username",
141       "avatarUrl": "avatarUrl",
142       "timezoneId": 1,
143       "localeId": 1,
144       "statusId": 1,
145       "phones": [
146         {}
147       ],
148       "primary": true,
149       "createDate": "2024-01-15T09:30:00Z",
150       "modifyDate": "2024-01-15T09:30:00Z",
151       "themeGk": 1000000,
152       "lookDate": "2024-01-15T09:30:00Z",
153       "unsubscribeDate": "2024-01-15T09:30:00Z",
154       "delegates": [
155         {}
156       ],
157       "emailSignature": "emailSignature",
158       "name": "name",
159       "displayName": "displayName",
160       "displayNameLastFirst": "displayNameLastFirst",
161       "bestEmail": "bestEmail",
162       "displayFullName": "displayFullName"
163     },
164     "legacyId": "legacyId",
165     "overrideEeoc": true,
166     "overrideVeteranStatus": true,
167     "overrideDisabledStatus": true,
168     "overrideJobBoardCompany": true,
169     "createMain": true,
170     "backOfficeTerm": {
171       "termGk": 1000000,
172       "name": "name",
173       "dueDays": 1,
174       "refNum": "refNum"
175     },
176     "accountName": "accountName",
177     "primarySalesUser": {
178       "userGk": 1000000,
179       "guid": "guid",
180       "salutation": {
181         "id": 1000000
182       },
183       "firstName": "firstName",
184       "middleName": "middleName",
185       "lastName": "lastName",
186       "nickname": "nickname",
187       "email": "email",
188       "workEmail": "workEmail",
189       "companyGk": 1000000,
190       "companyName": "companyName",
191       "companyGuid": "companyGuid",
192       "createUserGk": 1000000,
193       "modifyUserGk": 1000000,
194       "username": "username",
195       "avatarUrl": "avatarUrl",
196       "timezoneId": 1,
197       "localeId": 1,
198       "statusId": 1,
199       "phones": [
200         {}
201       ],
202       "primary": true,
203       "createDate": "2024-01-15T09:30:00Z",
204       "modifyDate": "2024-01-15T09:30:00Z",
205       "themeGk": 1000000,
206       "lookDate": "2024-01-15T09:30:00Z",
207       "unsubscribeDate": "2024-01-15T09:30:00Z",
208       "delegates": [
209         {}
210       ],
211       "emailSignature": "emailSignature",
212       "name": "name",
213       "displayName": "displayName",
214       "displayNameLastFirst": "displayNameLastFirst",
215       "bestEmail": "bestEmail",
216       "displayFullName": "displayFullName"
217     },
218     "additionSalesUsers": [
219       {}
220     ],
221     "showOverrideEEOC": true,
222     "udfSections": [
223       {}
224     ],
225     "showUdfSections": true,
226     "customer": {
227       "name": "name",
228       "description": "description",
229       "refNum": "refNum",
230       "updated": true,
231       "remove": true
232     },
233     "mainPhones": [
234       {}
235     ],
236     "tags": [
237       {}
238     ]
239   },
240   "createDate": "2024-01-15T09:30:00Z",
241   "modifyDate": "2024-01-15T09:30:00Z",
242   "createUser": {
243     "userGk": 1000000,
244     "guid": "guid",
245     "salutation": {
246       "id": 1000000,
247       "name": "name"
248     },
249     "firstName": "firstName",
250     "middleName": "middleName",
251     "lastName": "lastName",
252     "nickname": "nickname",
253     "email": "email",
254     "workEmail": "workEmail",
255     "type": {
256       "id": 1,
257       "name": "name"
258     },
259     "companyGk": 1000000,
260     "companyName": "companyName",
261     "companyGuid": "companyGuid",
262     "createUserGk": 1000000,
263     "modifyUserGk": 1000000,
264     "username": "username",
265     "avatarUrl": "avatarUrl",
266     "timezoneId": 1,
267     "localeId": 1,
268     "statusId": 1,
269     "phones": [
270       {}
271     ],
272     "primary": true,
273     "createUser": {
274       "userGk": 1000000,
275       "guid": "guid",
276       "salutation": {
277         "id": 1000000
278       },
279       "firstName": "firstName",
280       "middleName": "middleName",
281       "lastName": "lastName",
282       "nickname": "nickname",
283       "email": "email",
284       "workEmail": "workEmail",
285       "companyGk": 1000000,
286       "companyName": "companyName",
287       "companyGuid": "companyGuid",
288       "createUserGk": 1000000,
289       "modifyUserGk": 1000000,
290       "username": "username",
291       "avatarUrl": "avatarUrl",
292       "timezoneId": 1,
293       "localeId": 1,
294       "statusId": 1,
295       "displayName": "displayName",
296       "displayNameLastFirst": "displayNameLastFirst",
297       "bestEmail": "bestEmail",
298       "displayFullName": "displayFullName"
299     },
300     "modifyUser": {
301       "userGk": 1000000,
302       "guid": "guid",
303       "salutation": {
304         "id": 1000000
305       },
306       "firstName": "firstName",
307       "middleName": "middleName",
308       "lastName": "lastName",
309       "nickname": "nickname",
310       "email": "email",
311       "workEmail": "workEmail",
312       "companyGk": 1000000,
313       "companyName": "companyName",
314       "companyGuid": "companyGuid",
315       "createUserGk": 1000000,
316       "modifyUserGk": 1000000,
317       "username": "username",
318       "avatarUrl": "avatarUrl",
319       "timezoneId": 1,
320       "localeId": 1,
321       "statusId": 1,
322       "displayName": "displayName",
323       "displayNameLastFirst": "displayNameLastFirst",
324       "bestEmail": "bestEmail",
325       "displayFullName": "displayFullName"
326     },
327     "createDate": "2024-01-15T09:30:00Z",
328     "modifyDate": "2024-01-15T09:30:00Z",
329     "themeGk": 1000000,
330     "lookDate": "2024-01-15T09:30:00Z",
331     "unsubscribeDate": "2024-01-15T09:30:00Z",
332     "delegates": [
333       {}
334     ],
335     "emailSignature": "emailSignature",
336     "name": "name",
337     "displayName": "displayName",
338     "displayNameLastFirst": "displayNameLastFirst",
339     "bestEmail": "bestEmail",
340     "displayFullName": "displayFullName"
341   },
342   "modifyUser": {
343     "userGk": 1000000,
344     "guid": "guid",
345     "salutation": {
346       "id": 1000000,
347       "name": "name"
348     },
349     "firstName": "firstName",
350     "middleName": "middleName",
351     "lastName": "lastName",
352     "nickname": "nickname",
353     "email": "email",
354     "workEmail": "workEmail",
355     "type": {
356       "id": 1,
357       "name": "name"
358     },
359     "companyGk": 1000000,
360     "companyName": "companyName",
361     "companyGuid": "companyGuid",
362     "createUserGk": 1000000,
363     "modifyUserGk": 1000000,
364     "username": "username",
365     "avatarUrl": "avatarUrl",
366     "timezoneId": 1,
367     "localeId": 1,
368     "statusId": 1,
369     "phones": [
370       {}
371     ],
372     "primary": true,
373     "createUser": {
374       "userGk": 1000000,
375       "guid": "guid",
376       "salutation": {
377         "id": 1000000
378       },
379       "firstName": "firstName",
380       "middleName": "middleName",
381       "lastName": "lastName",
382       "nickname": "nickname",
383       "email": "email",
384       "workEmail": "workEmail",
385       "companyGk": 1000000,
386       "companyName": "companyName",
387       "companyGuid": "companyGuid",
388       "createUserGk": 1000000,
389       "modifyUserGk": 1000000,
390       "username": "username",
391       "avatarUrl": "avatarUrl",
392       "timezoneId": 1,
393       "localeId": 1,
394       "statusId": 1,
395       "displayName": "displayName",
396       "displayNameLastFirst": "displayNameLastFirst",
397       "bestEmail": "bestEmail",
398       "displayFullName": "displayFullName"
399     },
400     "modifyUser": {
401       "userGk": 1000000,
402       "guid": "guid",
403       "salutation": {
404         "id": 1000000
405       },
406       "firstName": "firstName",
407       "middleName": "middleName",
408       "lastName": "lastName",
409       "nickname": "nickname",
410       "email": "email",
411       "workEmail": "workEmail",
412       "companyGk": 1000000,
413       "companyName": "companyName",
414       "companyGuid": "companyGuid",
415       "createUserGk": 1000000,
416       "modifyUserGk": 1000000,
417       "username": "username",
418       "avatarUrl": "avatarUrl",
419       "timezoneId": 1,
420       "localeId": 1,
421       "statusId": 1,
422       "displayName": "displayName",
423       "displayNameLastFirst": "displayNameLastFirst",
424       "bestEmail": "bestEmail",
425       "displayFullName": "displayFullName"
426     },
427     "createDate": "2024-01-15T09:30:00Z",
428     "modifyDate": "2024-01-15T09:30:00Z",
429     "themeGk": 1000000,
430     "lookDate": "2024-01-15T09:30:00Z",
431     "unsubscribeDate": "2024-01-15T09:30:00Z",
432     "delegates": [
433       {}
434     ],
435     "emailSignature": "emailSignature",
436     "name": "name",
437     "displayName": "displayName",
438     "displayNameLastFirst": "displayNameLastFirst",
439     "bestEmail": "bestEmail",
440     "displayFullName": "displayFullName"
441   },
442   "primarySalesUser": {
443     "userGk": 1000000,
444     "guid": "guid",
445     "salutation": {
446       "id": 1000000,
447       "name": "name"
448     },
449     "firstName": "firstName",
450     "middleName": "middleName",
451     "lastName": "lastName",
452     "nickname": "nickname",
453     "email": "email",
454     "workEmail": "workEmail",
455     "type": {
456       "id": 1,
457       "name": "name"
458     },
459     "companyGk": 1000000,
460     "companyName": "companyName",
461     "companyGuid": "companyGuid",
462     "createUserGk": 1000000,
463     "modifyUserGk": 1000000,
464     "username": "username",
465     "avatarUrl": "avatarUrl",
466     "timezoneId": 1,
467     "localeId": 1,
468     "statusId": 1,
469     "phones": [
470       {}
471     ],
472     "primary": true,
473     "createUser": {
474       "userGk": 1000000,
475       "guid": "guid",
476       "salutation": {
477         "id": 1000000
478       },
479       "firstName": "firstName",
480       "middleName": "middleName",
481       "lastName": "lastName",
482       "nickname": "nickname",
483       "email": "email",
484       "workEmail": "workEmail",
485       "companyGk": 1000000,
486       "companyName": "companyName",
487       "companyGuid": "companyGuid",
488       "createUserGk": 1000000,
489       "modifyUserGk": 1000000,
490       "username": "username",
491       "avatarUrl": "avatarUrl",
492       "timezoneId": 1,
493       "localeId": 1,
494       "statusId": 1,
495       "displayName": "displayName",
496       "displayNameLastFirst": "displayNameLastFirst",
497       "bestEmail": "bestEmail",
498       "displayFullName": "displayFullName"
499     },
500     "modifyUser": {
501       "userGk": 1000000,
502       "guid": "guid",
503       "salutation": {
504         "id": 1000000
505       },
506       "firstName": "firstName",
507       "middleName": "middleName",
508       "lastName": "lastName",
509       "nickname": "nickname",
510       "email": "email",
511       "workEmail": "workEmail",
512       "companyGk": 1000000,
513       "companyName": "companyName",
514       "companyGuid": "companyGuid",
515       "createUserGk": 1000000,
516       "modifyUserGk": 1000000,
517       "username": "username",
518       "avatarUrl": "avatarUrl",
519       "timezoneId": 1,
520       "localeId": 1,
521       "statusId": 1,
522       "displayName": "displayName",
523       "displayNameLastFirst": "displayNameLastFirst",
524       "bestEmail": "bestEmail",
525       "displayFullName": "displayFullName"
526     },
527     "createDate": "2024-01-15T09:30:00Z",
528     "modifyDate": "2024-01-15T09:30:00Z",
529     "themeGk": 1000000,
530     "lookDate": "2024-01-15T09:30:00Z",
531     "unsubscribeDate": "2024-01-15T09:30:00Z",
532     "delegates": [
533       {}
534     ],
535     "emailSignature": "emailSignature",
536     "name": "name",
537     "displayName": "displayName",
538     "displayNameLastFirst": "displayNameLastFirst",
539     "bestEmail": "bestEmail",
540     "displayFullName": "displayFullName"
541   },
542   "primary": true,
543   "statusId": 1,
544   "customer": {
545     "name": "name",
546     "description": "description",
547     "refNum": "refNum",
548     "updated": true,
549     "remove": true
550   },
551   "accountName": "accountName",
552   "backOfficeTerm": {
553     "termGk": 1000000,
554     "name": "name",
555     "dueDays": 1,
556     "refNum": "refNum"
557   },
558   "additionSalesUsers": [
559     {
560       "userGk": 1000000,
561       "guid": "guid",
562       "salutation": {
563         "id": 1000000
564       },
565       "firstName": "firstName",
566       "middleName": "middleName",
567       "lastName": "lastName",
568       "nickname": "nickname",
569       "email": "email",
570       "workEmail": "workEmail",
571       "companyGk": 1000000,
572       "companyName": "companyName",
573       "companyGuid": "companyGuid",
574       "createUserGk": 1000000,
575       "modifyUserGk": 1000000,
576       "username": "username",
577       "avatarUrl": "avatarUrl",
578       "timezoneId": 1,
579       "localeId": 1,
580       "statusId": 1,
581       "phones": [
582         {}
583       ],
584       "primary": true,
585       "createDate": "2024-01-15T09:30:00Z",
586       "modifyDate": "2024-01-15T09:30:00Z",
587       "themeGk": 1000000,
588       "lookDate": "2024-01-15T09:30:00Z",
589       "unsubscribeDate": "2024-01-15T09:30:00Z",
590       "delegates": [
591         {}
592       ],
593       "emailSignature": "emailSignature",
594       "name": "name",
595       "displayName": "displayName",
596       "displayNameLastFirst": "displayNameLastFirst",
597       "bestEmail": "bestEmail",
598       "displayFullName": "displayFullName"
599     }
600   ],
601   "udfSections": [
602     {
603       "sectionGk": 1000000,
604       "sectionName": "sectionName",
605       "sortOrder": 1,
606       "fields": [
607         {}
608       ],
609       "fieldGk": 1000000,
610       "entityTypes": [
611         "1"
612       ]
613     }
614   ]
615 }

Delete Office Note