Admin Users APIs are highly configurable and require object identification prior to use.
POST user
Create/Add New User.
| Example |
curl --request POST \
--url https://hostname/user \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"user_id" : "2456",
"id" : "1221",
"fn" : "Firstname",
"ln" : "Lastname",
"un" : "[email protected]",
"lid" : "521",
"e" : "[email protected]",
"sms" : "1234567894",
"singleLocationUser" : "false",
"receiveLocationGroupDigests" : "false",
"todaysAgendaDispatchTime" : "6",
"tommAgendaDispatchTime" : "19",
"userTimezone" : "Asia/Kolkata",
"h24_mondays" : "NO",
"closed_mondays" : "NO",
"time_open_monday" : "09:00",
"time_close_monday" : "19:00",
"h24_tuesdays" : "NO",
"closed_tuesdays" : "NO",
"time_open_tuesday" : "09:00",
"time_close_tuesday" : "19:00",
"h24_wednesdays" : "NO",
"closed_wednesdays" : "NO",
"time_open_wednesday" : "09:00",
"time_close_wednesday" : "19:00",
"h24_thursdays" : "NO",
"closed_thursdays" : "NO",
"time_open_thursday" : "09:00",
"time_close_thursday" : "19:00",
"h24_fridays" : "NO",
"closed_fridays" : "NO",
"time_open_friday" : "09:00",
"time_close_friday" : "19:00",
"h24_saturdays" : "NO",
"closed_saturdays" : "NO",
"time_open_saturday" : "09:00",
"time_close_saturday" : "19:00",
"h24_sundays" : "NO",
"closed_sundays" : "NO",
"time_open_sunday" : "09:00",
"time_close_sunday" : "19:00",
"pass" : "5555-7777-6666-5555",
"gidsCsv" : "6,86,75,405",
"locGroupId" : "653",
}'
|
| user_id | User ID |
| id | acc_id |
| fn | First Name |
| ln | Last Name |
| un | Username |
| lid | Location ID |
| e | Email Address |
| sms | Mobile No for SMS |
| singleLocationUser | Single/Multi Location User |
| receiveLocationGroupDigests | Location Group Digest Received : Yes/No |
| todaysAgendaDispatchTime | Today’s Agenda Dispatch Time |
| tommAgendaDispatchTime | Tomorrow’s Agenda Dispatch Time |
| userTimezone | User Country Timezone |
| h24_mondays | Location open for 24 hours on mondays: Yes/No |
| closed_mondays | Location closed on mondays: Yes/No |
| time_open_monday | Opening time on monday |
| time_close_monday | Closing time on monday |
| h24_tuesdays | Location open for 24 hours on tuesdays: Yes/No |
| closed_tuesdays | Location closed on tuesdays: Yes/No |
| time_open_tuesday | Opening time on tuesday |
| time_close_tuesday | Closing time on tuesday |
| h24_wednesdays | Location open for 24 hours on wednesdays: Yes/No |
| closed_wednesdays | Location closed on wednesdays: Yes/No |
| time_open_wednesday | Opening time on wednesday |
| time_close_wednesday | Closing time on wednesday |
| h24_thursdays | Location open for 24 hours on thursdays: Yes/No |
| closed_thursdays | Location closed on thursdays: Yes/No |
| time_open_thursday | Opening time on thursday |
| time_close_thursday | Closing time on thursday |
| h24_fridays | Location open for 24 hours on fridays: Yes/No |
| closed_fridays | Location closed on fridays: Yes/No |
| time_open_friday | Opening time on friday |
| time_close_friday | Closing time on friday |
| h24_saturdays | Location open for 24 hours on saturdays: Yes/No |
| closed_saturdays | Location closed on saturdays: Yes/No |
| time_open_saturday | Opening time on saturday |
| time_close_saturday | Closing time on saturday |
| h24_sundays | Location open for 24 hours on sundays: Yes/No |
| closed_sundays | Location closed on sundays: Yes/No |
| time_open_sunday | Opening time on sunday |
| time_close_sunday | Closing time on sunday |
| pass | User Account Password |
| gidsCsv | Group Ids List |
| locGroupid: | Location Group ID |
GET users/user/{userid}
Get/Fetch User Data.
| Example |
curl --request GET \
--url https://hostname/users/user/{userid} \
--header 'content-type: application/json' \
--header 'x-auth-token: 555-555-1212' \
--header 'x-auth-user: joe.user' \
--data '{
"id": 4461,
"first_name": "Firstname",
"last_name": "Lastname",
"username": "[email protected]",
"location_id": "521",
"created_by_user_id": "4451",
"status": "ACTIVE",
"email": "[email protected]",
"smstxt_country_code": "+1",
"smstxt": "1234567856",
"single_location_user": "0",
"receive_default_location_notifications": "0",
"receive_location_group_digests": "0",
"tomm_agenda_dispatch_time": null,
"tomm_agenda_dispatch_timezone": null,
"todays_agenda_dispatch_time": null,
"user_timezone": "Asia/Kolkata",
"hash": "5555-7777-6666-4444",
--avatars: [
'{
"user_id": "4461",
"digital_asset_id": "100004991",
"filename": "filename.jpg",
"digital_asset_type": "1",
"digital_asset_type_name": "fullsize",
"digital_asset_status": "ACTIVE",
"url": "https://hostame/filename.jpg"
}'
],
"group_id": "5",
"singleLocationUser": false,
"receiveDefaultLocationNotifications": false,
"receiveLocationGroupDigests": false,
"todaysAgendaDispatchTime": "06",
"tommAgendaDispatchTime": "23",
"userTimezone": "Asia/Kolkata",
"user_org_id": "1",
"location": "521",
"virtual_location": {
"id": "8781",
"name": "Firstname Lastname ([email protected])",
"address1": "2724 Villas Way",
"address2": "",
"city": "San Diego",
"state_province": "CA",
"postal_code": "92108",
"longitude": "-117.1340473",
"latitude": "32.7840922",
"pri_organization_id": "1",
"timezone": "Asia/Kolkata",
"email": null,
"smstxt": null,
"uuid": "",
"alias": null,
"region_id": "1",
"floor_plan_format_id": "2",
"fact_id": null,
"store_code": "[email protected]_521",
"status": "ACTIVE",
"time_open_monday": "09:00",
"time_open_tuesday": "09:00",
"time_open_wednesday": "09:00",
"time_open_thursday": "09:00",
"time_open_friday": "09:00",
"time_open_saturday": "09:00",
"time_open_sunday": "09:00",
"time_close_monday": "19:00",
"time_close_tuesday": "19:00",
"time_close_wednesday": "19:00",
"time_close_thursday": "19:00",
"time_close_friday": "19:00",
"time_close_saturday": "19:00",
"time_close_sunday": "19:00",
"rvp_id": null,
"dir_id": null,
"country_iso3": "USA",
"timestamp_row_added": "2022-09-29 01:44:22",
"closed_mondays": "NO",
"closed_tuesdays": "NO",
"closed_wednesdays": "NO",
"closed_thursdays": "NO",
"closed_fridays": "NO",
"closed_saturdays": "NO",
"closed_sundays": "NO",
"h24_mondays": "NO",
"h24_tuesdays": "NO",
"h24_wednesdays": "NO",
"h24_thursdays": "NO",
"h24_fridays": "NO",
"h24_saturdays": "NO",
"h24_sundays": "NO",
"location_type": "2"
},
"isRestrictedAccessUser": false,
"isWebAdmin": false
},
|
| user_id | User ID |
| id | acc_id |
| fn | First Name |
| ln | Last Name |
| un | Username |
| lid | Location ID |
| e | Email Address |
| sms | Mobile No for SMS |
| singleLocationUser | Single/Multi Location User |
| receiveLocationGroupDigests | Location Group Digest Received : Yes/No |
| todaysAgendaDispatchTime | Today’s Agenda Dispatch Time |
| tommAgendaDispatchTime | Tomorrow’s Agenda Dispatch Time |
| userTimezone | User Country Timezone |
| h24_mondays | Location open for 24 hours on mondays: Yes/No |
| closed_mondays | Location closed on mondays: Yes/No |
| time_open_monday | Opening time on monday |
| time_close_monday | Closing time on monday |
| h24_tuesdays | Location open for 24 hours on tuesdays: Yes/No |
| closed_tuesdays | Location closed on tuesdays: Yes/No |
| time_open_tuesday | Opening time on tuesday |
| time_close_tuesday | Closing time on tuesday |
| h24_wednesdays | Location open for 24 hours on wednesdays: Yes/No |
| closed_wednesdays | Location closed on wednesdays: Yes/No |
| time_open_wednesday | Opening time on wednesday |
| time_close_wednesday | Closing time on wednesday |
| h24_thursdays | Location open for 24 hours on thursdays: Yes/No |
| closed_thursdays | Location closed on thursdays: Yes/No |
| time_open_thursday | Opening time on thursday |
| time_close_thursday | Closing time on thursday |
| h24_fridays | Location open for 24 hours on fridays: Yes/No |
| closed_fridays | Location closed on fridays: Yes/No |
| time_open_friday | Opening time on friday |
| time_close_friday | Closing time on friday |
| h24_saturdays | Location open for 24 hours on saturdays: Yes/No |
| closed_saturdays | Location closed on saturdays: Yes/No |
| time_open_saturday | Opening time on saturday |
| time_close_saturday | Closing time on saturday |
| h24_sundays | Location open for 24 hours on sundays: Yes/No |
| closed_sundays | Location closed on sundays: Yes/No |
| time_open_sunday | Opening time on sunday |
| time_close_sunday | Closing time on sunday |
| pass | User Account Password |
| gidsCsv | Group Ids List |
| locGroupid: | Location Group ID |