{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":576,"path":"api-reference/rest-apis/wsd_presence-api.md","title":"WSD Presence API","bundle":null,"doc_type":null,"release":"australia","body":"\n# WSD Presence API\n\nThe WSD Presence API enables users to manage their in-office presence schedule, including weekly routines, one-time exceptions, and collaborator visibility.\n\nThis API supports the Workplace Service Delivery \\(WSD\\) Concierge experience by enabling employees to communicate their planned office attendance to colleagues. Use this API for the following actions:\n\n-   Retrieve an authenticated user's complete presence data, including their weekly in-office routine, scheduled exceptions, and optionally collaborators' presence information.\n-   Manage weekly in-office routines so employees can set a recurring schedule.\n-   Create and manage one-time exceptions that override the routine for a specific date.\n-   View and manage collaborators to enable coordinated in-office planning.\n\nAn authenticated user is someone who is logged in or whose credentials are included in the API request. Call endpoints in any order; each operates independently.\n\nThe WSD Presence API belongs to the sn\\_wsd\\_concierge namespace. The [WSD Reservation API](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/wsd_reservation-api.md) `GET /user/context` endpoint can return presence schedule data from the WSD Presence API when the concierge plugin is active.\n\n## Requirements\n\nThe WSD Presence API requires:\n\n-   The sn\\_wsd\\_core.workplace\\_user role assigned to the user.\n-   The Workplace Service Delivery Core \\(com.sn\\_wsd\\_core\\) and Workplace Service Delivery Concierge \\(com.sn\\_wsd\\_concierge\\) plugins activated.\n-   At least one user record must exist in User \\[sys\\_user\\] table with the sn\\_wsd\\_core.workplace\\_user role assigned.\n\n**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md)\n\n## WSD Presence - DELETE /api/sn\\_wsd\\_concierge/v1/presence/collaborator/\\{collaborator\\_id\\}\n\nRemoves a collaborator from the authenticated user’s presence visibility list. Use this endpoint when a user no longer wants to track a colleague’s office attendance.\n\nAn authenticated user is someone who is logged in or whose credentials are included in the API request. The collaborator is identified by their sys\\_id.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/collaborator/{collaborator_id}`\n\nDefault URL: `/api/sn_wsd_concierge/presence/collaborator/{collaborator_id}`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr><tr><td>\n\ncollaborator\\_id\n\n</td><td>\n\nSys\\_id of the collaborator to remove from the user’s visibility list.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing or invalid collaborator\\_id path parameter.|\n|404|Not Found. The specified collaborator wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n  \"message\": \"String\"\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the number of collaborators removed.Data type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example removes a specific collaborator from the authenticated user’s presence visibility list.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator/usr1a2b3c4d5e6\" \\\n--request DELETE \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"1 collaborator(s) removed\"\n  }\n}\n```\n\n## WSD Presence - DELETE /api/sn\\_wsd\\_concierge/v1/presence/exception/\\{exception\\_id\\}\n\nDeletes a specific presence exception identified by its sys\\_id. Use this endpoint when a user wants to remove a one-time override and revert to their regular weekly routine for that date.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/exception/{exception_id}`\n\nDefault URL: `/api/sn_wsd_concierge/presence/exception/{exception_id}`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr><tr><td>\n\nexception\\_id\n\n</td><td>\n\nRequired. Sys\\_id of the presence exception to delete.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing or invalid exception\\_id path parameter.|\n|404|Not Found. The specified exception wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n  \"message\": \"String\"\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the exception was deleted.Data type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example deletes exception exc1a2b3c4d5e6, reverting that date to the user’s regular weekly routine.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception/exc1a2b3c4d5e6\" \\\n--request DELETE \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"Exception deleted successfully\"\n  }\n}\n```\n\n## WSD Presence - GET /api/sn\\_wsd\\_concierge/v1/presence/collaborator\n\nRetrieves the list of collaborators for the authenticated user along with each collaborator’s presence data, routine, and exceptions. Use this endpoint to view the office attendance schedules of colleagues, enabling coordinated in-office planning.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/collaborator`\n\nDefault URL: `/api/sn_wsd_concierge/presence/collaborator`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|404|Not Found. The user wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n  \"count\": Number,\n  \"collaborators\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.count\n\n</td><td>\n\nTotal number of collaborators returned. Data type: Number\n\n</td></tr><tr><td>\n\nresult.collaborators\n\n</td><td>\n\nList of collaborators with their presence data. If a collaborator has privacy enabled, **privacy\\_enabled** is true with null **routine** and empty **exceptions**.\n\nData type: Array of Objects\n\n```\n\"collaborators\": [\n {\n  \"sys_id\": \"String\", \n  \"name\": \"String\", \n  \"privacy_enabled\": Boolean,\n  \"routine\": {Object},\n  \"exceptions\": [Array]\n }\n]\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.sys\\_id\n\n</td><td>\n\nSys\\_id of the collaborator's user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.name\n\n</td><td>\n\nDisplay name of the collaborator as it appears in their sys\\_user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.privacy\\_enabled\n\n</td><td>\n\nBoolean. Flag that indicates whether the collaborator has enabled privacy on their presence data.Valid values:\n\n-   `true`: The collaborator's routine and exceptions are hidden. **routine** will be `null` and **exceptions** will be an empty array.\n-   `false`: The collaborator's presence data is visible.\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.collaborators.routine\n\n</td><td>\n\nCollaborator's weekly in-office routine. Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when collaborator plans to be in-office for that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": Boolean\" \n   \"tuesday\": Boolean, \n   \"wednesday\": Boolean, \n   \"thursday\": Boolean, \n   \"friday\": Boolean, \n   \"saturday\": Boolean, \n   \"sunday\": Boolean \n}\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions\n\n</td><td>\n\nCollaborator's one-time presence exceptions. Returns an empty array if `privacy_enabled` is `true`.Data type: Array of Objects\n\n```\n\"exceptions\": [ \n { \n  \"sys_id\": \"String\", \n  \"date\": \"String\", \n  \"in_office\": Boolean, \n  \"origin\": \"String\", \n  \"location\": \"String\" \n } \n]\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.date\n\n</td><td>\n\nDate this exception applies to. This is the date the user's routine is being overridden.Format: yyyy-MM-dd\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.location\n\n</td><td>\n\nName or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example retrieves all collaborators and their presence data for the authenticated user.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator\" \\\n--request GET \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"count\": 2,\n    \"collaborators\": [\n      {\n        \"sys_id\": \"usr1a2b3c4d5e6\", \"name\": \"Jane Smith\", \"privacy_enabled\": false,\n        \"routine\": {\n          \"monday\": true, \"tuesday\": true, \"wednesday\": false,\n          \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false\n        },\n        \"exceptions\": [\n          { \"sys_id\": \"exc1a2b3c\", \"date\": \"2026-03-10\", \"in_office\": true, \"origin\": \"user\", \"location\": \"Building B\" }\n        ]\n      },\n      { \"sys_id\": \"usr7f8g9h0i1j2\", \"name\": \"John Doe\", \"privacy_enabled\": true, \"routine\": null, \"exceptions\": [] }\n    ]\n  }\n}\n```\n\n## WSD Presence - GET /api/sn\\_wsd\\_concierge/v1/presence/exception\n\nRetrieves presence exceptions for the authenticated user. Exceptions can be filtered by a date range or by a specific exception sys\\_id. Use this endpoint when you need to view one-time overrides to a user’s weekly routine.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/exception`\n\nDefault URL: `/api/sn_wsd_concierge/presence/exception`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table><table class=\"rest_api_query_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nexception\\_id\n\n</td><td>\n\nSys\\_id of a specific exception to retrieve.When provided, overrides the date range filter and returns only the matching exception.\n\nTable: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr><tr><td>\n\nexception\\_start\\_date\n\n</td><td>\n\nStart date for filtering exceptions.Format: yyyy-MM-dd\n\nData type: String\n\nDefault: Today\n\n</td></tr><tr><td>\n\nexception\\_end\\_date\n\n</td><td>\n\nEnd date for filtering exceptions.Format: yyyy-MM-dd\n\nData type: String\n\nDefault: Today +3 months\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Invalid date format for exception\\_start\\_date or exception\\_end\\_date.|\n|404|Not Found. The specified exception wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n  \"exceptions\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.exceptions\n\n</td><td>\n\nList of presence exceptions matching the filter criteria.Data type: Array of Objects\n\n```\n\"exceptions\": [\n{\n  \"sys_id\": \"sys_id\", \n  \"date\": \"String\", \n  \"in_office\": String, \n  \"origin\": \"String\", \n  \"location\": \"String\" \n }\n]\n```\n\n</td></tr><tr><td>\n\nresult.exceptions.date\n\n</td><td>\n\nDate this exception applies to. This is the date the user's routine is being overridden.Format: yyyy-MM-dd format\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.exceptions.location\n\n</td><td>\n\nThe name or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example retrieves all exceptions for the first half of 2026.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception?exception_start_date=2026-01-01&exception_end_date=2026-06-30\" \\\n--request GET \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"exceptions\": [\n      { \"sys_id\": \"exc1a2b3c4d5e6\", \"date\": \"2026-02-14\", \"in_office\": true, \"origin\": \"user\", \"location\": \"Building A\" },\n      { \"sys_id\": \"exc7f8g9h0i1j2\", \"date\": \"2026-03-17\", \"in_office\": false, \"origin\": \"system\", \"location\": \"\" }\n    ]\n  }\n}\n```\n\n## WSD Presence - GET /api/sn\\_wsd\\_concierge/v1/presence\n\nRetrieves the authenticated user’s complete presence data, including their weekly in-office routine, scheduled presence exceptions, and optionally their collaborators’ presence information.\n\nUse this endpoint to get a holistic view of a user’s planned office attendance. You can also query another user’s presence data by providing their sys\\_id, subject to privacy settings.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence`\n\nDefault URL: `/api/sn_wsd_concierge/presence`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table><table class=\"rest_api_query_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nuser\\_id\n\n</td><td>\n\nSys\\_id of the target user whose presence data to retrieve. If not provided, returns presence data for the authenticated user.**Note:** To query another user's presence data, the caller must have the admin role. Without it, the request returns 401 Unauthorized.\n\nTable: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nexception\\_start\\_date\n\n</td><td>\n\nStart date for filtering presence exceptions.Format: yyyy-MM-dd\n\nData type: String\n\nDefault: Today\n\n</td></tr><tr><td>\n\nexception\\_end\\_date\n\n</td><td>\n\nEnd date for filtering presence exceptions.Format: yyyy-MM-dd\n\nData type: String\n\nDefault: Today + 3 months\n\n</td></tr><tr><td>\n\ninclude\n\n</td><td>\n\nRelated data to include in the response.Only valid value: `collaborators`\n\nData type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Invalid date format for exception\\_start\\_date or exception\\_end\\_date, or invalid user\\_id format.|\n|401|Unauthorized. The authenticated user doesn't have permission to view the target user’s presence data. Returned when user\\_id is provided and doesn't match the authenticated user.|\n|404|Not Found. The specified user wasn't found.|\n|500|Internal Server Error. An unexpected error occurred while processing the request.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the response.```\n\"result\": {\n  \"routine\": {Object},\n  \"exceptions\": [Array],\n  \"collaborators\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.routine\n\n</td><td>\n\nWeekly in-office routine for the user. Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the authenticated user plans to be in-office that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": Boolean, \n   \"tuesday\": Boolean, \n   \"wednesday\": Boolean, \n   \"thursday\": Boolean, \n   \"friday\": Boolean, \n   \"saturday\": Boolean, \n   \"sunday\": Boolean \n}\n```\n\n</td></tr><tr><td>\n\nresult.exceptions\n\n</td><td>\n\nList of one-time presence exceptions that override the user’s routine for specific dates.Data type: Array of Objects\n\n```\n\"exceptions\": [ \n   { \n     \"sys_id\": \"String\", \n     \"date\": \"String\", \n     \"in_office\": Boolean, \n     \"origin\": \"String\", \n     \"location\": \"String\" \n   } \n]\n```\n\n</td></tr><tr><td>\n\nresult.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.date\n\n</td><td>\n\nDate this exception applies to, in yyyy-MM-dd format. This is the date the user's routine is being overridden.Data type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.exceptions.location\n\n</td><td>\n\nThe name or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr><tr><td>\n\nresult.collaborators\n\n</td><td>\n\nList of collaborators and their presence data. Only returned when `include=collaborators` is specified.If a collaborator has privacy enabled, **privacy\\_enabled** is true with null **routine** and empty **exceptions**.\n\nData type: Array of Objects\n\n```\n\"collaborators\": [ \n   { \n     \"sys_id\": \"String\", \n     \"name\": \"String\", \n     \"privacy_enabled\": Boolean, \n     \"routine\": {Object}, \n     \"exceptions\": [Array]\n   } \n]\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.sys\\_id\n\n</td><td>\n\nSys\\_id of the collaborator's user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.name\n\n</td><td>\n\nThe display name of the collaborator as it appears in their sys\\_user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.privacy\\_enabled\n\n</td><td>\n\nBoolean. Flag that indicates whether the collaborator has enabled privacy on their presence data.Valid values:\n\n-   `true`: The collaborator's routine and exceptions are hidden. **routine** will be `null` and **exceptions** will be an empty array.\n-   `false`: The collaborator's presence data is visible.\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.collaborators.routine\n\n</td><td>\n\nThe collaborator's weekly in-office routine.Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the collaborator plans to be in-office that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": Boolean, \n   \"tuesday\": Boolean, \n   \"wednesday\": Boolean, \n   \"thursday\": Boolean, \n   \"friday\": Boolean, \n   \"saturday\": Boolean, \n   \"sunday\": Boolean \n}\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions\n\n</td><td>\n\nThe collaborator's one-time presence exceptions. Follows the same structure as the authenticated user's **exceptions** parameter. Returns an empty array if `privacy_enabled` is `true`.Data type: Array of Objects\n\n```\n\"exceptions\": [ \n   { \n     \"sys_id\": \"String\", \n     \"date\": \"String\", \n     \"in_office\": Boolean, \n     \"origin\": \"String\", \n     \"location\": \"String\" \n   } \n]\n```\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example retrieves the authenticated user’s full presence data, including collaborator schedules, for exceptions in Q1 2026.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence?include=collaborators&exception_start_date=2026-01-01&exception_end_date=2026-03-31\" \\\n--request GET \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"routine\": {\n      \"monday\": true,  \"tuesday\": false, \"wednesday\": true,\n      \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false\n    },\n    \"exceptions\": [\n      {\n        \"sys_id\": \"a1b2c3d4e5f6\",\n        \"date\": \"2026-02-14\",\n        \"in_office\": true,\n        \"origin\": \"user\",\n        \"location\": \"Building A\"\n      }\n    ],\n    \"collaborators\": [\n      {\n        \"sys_id\": \"f6e5d4c3b2a1\",\n        \"name\": \"Jane Smith\",\n        \"privacy_enabled\": false,\n        \"routine\": {\n          \"monday\": true, \"tuesday\": true, \"wednesday\": false,\n          \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false\n        },\n        \"exceptions\": []\n      }\n    ]\n  }\n}\n\n```\n\n## WSD Presence - GET /api/sn\\_wsd\\_concierge/v1/presence/routine\n\nRetrieves only the authenticated user’s weekly in-office routine. This is a lightweight alternative to GET /presence when you only need the routine schedule without exceptions or collaborators.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/routine`\n\nDefault URL: `/api/sn_wsd_concierge/presence/routine`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|404|Not Found. The user or routine wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n  \"user_id\": \"String\",\n  \"routine\": {Object}\n}\n```\n\n</td></tr><tr><td>\n\nresult.user\\_id\n\n</td><td>\n\nSys\\_id of the user whose routine is returned.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.routine\n\n</td><td>\n\nUser's recurring weekly in-office schedule. Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the user plans to be in-office that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": {\n  \"monday\": Boolean,\n  \"tuesday\": Boolean,\n  \"wednesday\": Boolean,\n  \"thursday\": Boolean, \n  \"friday\": Boolean,\n  \"saturday\": Boolean,\n  \"sunday\": Boolean\n}\n```\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example retrieves the weekly in-office routine for the authenticated user.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine\" \\\n--request GET \\\n--header \"Accept: application/json\" \\\n--user \"username:password\"\n```\n\nResponse body. Shows that the user's routine shows in-office attendance for Monday through Thursday.\n\n```\n{\n  \"result\": {\n    \"user_id\": \"a1b2c3d4e5f6g7h8\",\n    \"routine\": {\n      \"monday\": true,  \"tuesday\": true,  \"wednesday\": true,\n      \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false\n    }\n  }\n}\n```\n\n## WSD Presence - PATCH /api/sn\\_wsd\\_concierge/v1/presence/routine\n\nPartially updates the authenticated user’s weekly in-office routine. Use this endpoint when a user needs to adjust specific days without resetting the entire schedule.\n\nOnly the days provided in the request body are updated. All other days remain unchanged.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/routine`\n\nDefault URL: `/api/sn_wsd_concierge/presence/routine`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n<table class=\"rest_api_request_body\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nroutine\n\n</td><td>\n\nRequired. The authenticated user's weekly routine.Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the authenticated user plans to be in-office that day, and `false` when attendance isn't planned.\n\nDays omitted in the request remain unchanged. An empty routine object is accepted as a no-op.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": \"Boolean\", \n   \"tuesday\": \"Boolean\", \n   \"wednesday\": \"Boolean\", \n   \"thursday\": \"Boolean\", \n   \"friday\": \"Boolean\", \n   \"saturday\": \"Boolean\", \n   \"sunday\": \"Boolean\" \n}\n```\n\n</td></tr></tbody>\n</table>### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n|Content-Type|Data format of the request body: application/json.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing request body, invalid format, or no valid day fields provided.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n \"message\": \"String\",\n \"result\": {Object}\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the routine was updated.Data type: String\n\n</td></tr><tr><td>\n\nresult.result\n\n</td><td>\n\nContains the complete updated routine object with all seven days including unchanged days.Data type: Object\n\n```\n\"result\": { \n  \"routine\": {Object} \n}\n```\n\n</td></tr><tr><td>\n\nresult.routine\n\n</td><td>\n\nWeekly in-office routine. Contains a Boolean flag for each day of the week where `true` indicates in-office attendance, and `false` indicates no attendance.Data type: Object\n\n```\n\"routine\": { \n  \"monday\": \"Boolean\", \n  \"tuesday\": \"Boolean\",\n  \"wednesday\": \"Boolean\", \n  \"thursday\": \"Boolean\",\n  \"friday\": \"Boolean\", \n  \"saturday\": \"Boolean\", \n  \"sunday\": \"Boolean\"\n}\n\n```\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example updates only Friday and Saturday to true, leaving all other days unchanged.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine\" \\\n--request PATCH \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--user \"username:password\" \\\n--data '{\n  \"routine\": { \"friday\": true, \"saturday\": true }\n}'\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"Routine updated successfully\",\n    \"result\": {\n      \"routine\": {\n        \"monday\": true, \"tuesday\": true, \"wednesday\": true,\n        \"thursday\": true, \"friday\": true, \"saturday\": true, \"sunday\": false\n      }\n    }\n  }\n}\n```\n\n## WSD Presence - POST /api/sn\\_wsd\\_concierge/v1/presence/collaborator\n\nAdds one or more collaborators to the authenticated user’s presence visibility list. Collaborators can then view each other’s presence data. Use this endpoint to build a team or group of colleagues whose office attendance you want to track.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/collaborator`\n\nDefault URL: `/api/sn_wsd_concierge/presence/collaborator`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n<table class=\"rest_api_request_body\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\ncollaborator\\_ids\n\n</td><td>\n\nRequired. Non-empty array of sys\\_id values identifying users to add as collaborators.Table: User \\[sys\\_user\\]\n\n Data type: Array of Strings```\n\"collaborator_ids\": [\"String\", \"String\"]\n```\n\n</td></tr></tbody>\n</table>### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n|Content-Type|Data format of the request body: application/json.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing collaborator\\_ids, empty array, or invalid sys\\_id format.|\n|404|Not Found. One or more collaborator sys\\_ids weren't found in the sys\\_user table.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\nresult\": {\n  \"message\": \"String\",\n  \"collaborators\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating collaborator\\(s\\) were added. Data type: String\n\n</td></tr><tr><td>\n\nresult.collaborators\n\n</td><td>\n\nList of the newly added collaborators with their presence data.Data type: Array of Objects\n\n```\n\"collaborators\": [\n {\n  \"sys_id\": \"String\",\n  \"name\": \"String\",\n  \"privacy_enabled\": Boolean,\n  \"routine\": {Object},\n  \"exceptions\": [Array]\n }\n]\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.sys\\_id\n\n</td><td>\n\nSys\\_id of the collaborator's user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.name\n\n</td><td>\n\nThe display name of the collaborator as it appears in their sys\\_user record.Table: User \\[sys\\_user\\]\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.privacy\\_enabled\n\n</td><td>\n\nBoolean. Flag that indicates whether the collaborator has enabled privacy on their presence data.Valid values:\n\n-   true: The collaborator's routine and exceptions are hidden. **routine** will be `null` and **exceptions** will be an empty array.\n-   false: The collaborator's presence data is visible.\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.collaborators.routine\n\n</td><td>\n\nThe collaborator's weekly in-office routine. Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the collaborator plans to be in-office that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": Boolean, \n   \"tuesday\": Boolean, \n   \"wednesday\": Boolean, \n   \"thursday\": Boolean, \n   \"friday\": Boolean, \n   \"saturday\": Boolean, \n   \"sunday\": Boolean\n}\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions\n\n</td><td>\n\nThe collaborator's one-time presence exceptions. Returns an empty array if `privacy_enabled` is `true`.Data type: Array of Objects\n\n```\n\"exceptions\": [ \n   { \n     \"sys_id\": \"String\", \n     \"date\": \"String\", \n     \"in_office\": Boolean, \n     \"origin\": \"String\", \n     \"location\": \"String\" \n   } \n]\n```\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.date\n\n</td><td>\n\nDate this exception applies to. This is the date the user's routine is being overridden.Format: yyyy-MM-dd format\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.collaborators.exceptions.location\n\n</td><td>\n\nThe name or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example adds two users as collaborators by providing their sys\\_ids.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/collaborator\" \\\n--request POST \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--user \"username:password\" \\\n--data '{\n  \"collaborator_ids\": [\"usr1a2b3c4d5e6\", \"usr7f8g9h0i1j2\"]\n}'\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"Collaborator(s) added successfully\",\n    \"collaborators\": [\n      {\n        \"sys_id\": \"usr1a2b3c4d5e6\", \"name\": \"Jane Smith\", \"privacy_enabled\": false,\n        \"routine\": { \"monday\": true, \"tuesday\": true, \"wednesday\": false, \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false },\n        \"exceptions\": []\n      },\n      { \"sys_id\": \"usr7f8g9h0i1j2\", \"name\": \"John Doe\", \"privacy_enabled\": true, \"routine\": null, \"exceptions\": [] }\n    ]\n  }\n}\n```\n\n## WSD Presence - POST /api/sn\\_wsd\\_concierge/v1/presence/exception\n\nCreates a one-time presence exception for the authenticated user on a specific date. Use this endpoint when a user plans to be in the office on a day they normally work remotely, or vice versa.\n\nExceptions override the user’s weekly routine for that date.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/exception`\n\nDefault URL: ```/api/sn_wsd_concierge/presence/exception`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n<table class=\"rest_api_request_body\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nexception\n\n</td><td>\n\nRequired. Exception object defining the one-time presence override.Data type: Object\n\n```\n\"exception\": { \n  \"date\": \"String\", \n  \"in_office\": \"Boolean\",\n  \"location\": \"String\", \n  \"origin\": \"String\"\n}\n```\n\n</td></tr><tr><td>\n\nexception.date\n\n</td><td>\n\nDate of the exception.Format: yyyy-MM-dd\n\nData type: String\n\n</td></tr><tr><td>\n\nexception.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date.Possible values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office.\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nexception.location\n\n</td><td>\n\nName or identifier of the office location for this exception.Data type: String\n\n</td></tr><tr><td>\n\nexception.origin\n\n</td><td>\n\nSource of the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\n Data type: String\n\n</td></tr></tbody>\n</table>### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n|Content-Type|Data format of the request body: application/json.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing required field date or invalid date format.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing the result of the request.Data type: Object\n\n```\n\"result\": {\n    \"message\": \"String\",\n    \"result\": {Object}\n  }\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the exception was added.Data type: String\n\n</td></tr><tr><td>\n\nresult.result\n\n</td><td>\n\nObject containing the created exception\\(s\\).Data type: Object\n\n```\n\"result\": {\n \"exceptions\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.exceptions\n\n</td><td>\n\nArray containing details about the created exception\\(s\\).Data type: Array of Objects\n\n```\n\"exceptions\": [\n {\n  \"date\": \"String\",\n  \"location\": \"String\",\n  \"in_office\": Boolean,\n  \"origin\": \"String\",\n  \"sys_id\": \"String\"\n }\n]\n```\n\n</td></tr><tr><td>\n\nresult.result.exceptions.date\n\n</td><td>\n\nDate this exception applies to, in yyyy-MM-dd format. This is the date the user's routine is being overridden.Data type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.result.exceptions.location\n\n</td><td>\n\nThe name or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example creates a presence exception for February 14, 2026, marking the user as in-office at Building A.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception\" \\\n--request POST \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--user \"username:password\" \\\n--data '{\n  \"exception\": {\n    \"date\": \"2026-02-14\",\n    \"in_office\": true,\n    \"location\": \"Building A - Floor 3\",\n    \"origin\": \"user\"\n  }\n}'\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"Exception added successfully\",\n    \"result\": {\n      \"exceptions\": [\n        {\n          \"sys_id\": \"a1b2c3d4e5f6g7h8\",\n          \"date\": \"2026-02-14\",\n          \"in_office\": true,\n          \"origin\": \"user\",\n          \"location\": \"Building A - Floor 3\"\n        }\n      ]\n    }\n  }\n}\n```\n\n## WSD Presence - POST /api/sn\\_wsd\\_concierge/v1/presence/routine\n\nCreates a new weekly in-office routine for the authenticated user. Use this endpoint when a user is setting up their presence routine for the first time.\n\nAll seven days of the week must be provided as Boolean values.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/routine`\n\nDefault URL: `/api/sn_wsd_concierge/presence/routine`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n<table class=\"rest_api_request_body\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nroutine\n\n</td><td>\n\nRequired. Weekly in-office routine for the user.Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the user plans to be in-office that day, and `false` when attendance isn't planned.\n\nAll days are required.\n\nData type: Object\n\n```\n\"routine\": { \n   \"monday\": \"Boolean\", \n   \"tuesday\": \"Boolean\", \n   \"wednesday\": \"Boolean\", \n   \"thursday\": \"Boolean\", \n   \"friday\": \"Boolean\", \n   \"saturday\": \"Boolean\", \n   \"sunday\": \"Boolean\" \n}\n```\n\n</td></tr></tbody>\n</table>### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n|Content-Type|Data format of the request body: application/json.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing required field\\(s\\) or invalid data type. All seven days must be provided as Boolean values.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n \"message\": \"String\",\n \"result\": {Object}\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the routine was created.Data type: String\n\n</td></tr><tr><td>\n\nresult.result\n\n</td><td>\n\nContains the created routine object with all seven days.Data type: Object\n\n```\n\"result\": { \n  \"routine\": {Object} \n}\n```\n\n</td></tr><tr><td>\n\nresult.routine\n\n</td><td>\n\nUser's weekly in-office routine. Contains a Boolean flag for each day of the week indicating planned office attendance. Displays `true` when the user plans to be in-office that day, and `false` when attendance isn't planned.\n\nData type: Object\n\n```\n\"routine\": { \n  \"monday\": \"Boolean\", \n  \"tuesday\": \"Boolean\",\n  \"wednesday\": \"Boolean\", \n  \"thursday\": \"Boolean\",\n  \"friday\": \"Boolean\", \n  \"saturday\": \"Boolean\", \n  \"sunday\": \"Boolean\"\n}\n```\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example creates a weekly in-office routine for Monday through Thursday.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/routine\" \\\n--request POST \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--user \"username:password\" \\\n--data '{\n  \"routine\": {\n    \"monday\": true, \"tuesday\": true, \"wednesday\": true,\n    \"thursday\": true, \"friday\": false, \"saturday\": false, \"sunday\": false\n  }\n}'\n```\n\nResponse body.\n\n```\n{\n  \"result\": {\n    \"message\": \"Routine created successfully\",\n    \"result\": {\n      \"routine\": {\n        \"monday\": true, \n        \"tuesday\": true, \n        \"wednesday\": true,\n        \"thursday\": true, \n        \"friday\": false, \n        \"saturday\": false,\n        \"sunday\": false\n      }\n    }\n  }\n}\n```\n\n## WSD Presence - PUT /api/sn\\_wsd\\_concierge/v1/presence/exception\n\nUpdates an existing presence exception by canceling it and creating a replacement. The original exception is identified by its sys\\_id. Use this endpoint when a user needs to change the details of a previously created exception.\n\nBecause this endpoint cancels the original exception and creates a replacement, the returned `sys_id` differs from the one provided in the request. Update any stored references to the exception `sys_id` after a successful PUT.\n\n### URL format\n\nVersioned URL: `/api/sn_wsd_concierge/{api_version}/presence/exception`\n\nDefault URL: `/api/sn_wsd_concierge/presence/exception`\n\n### Supported request parameters\n\n<table class=\"rest_api_path_parameters\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\napi\\_version\n\n</td><td id=\"version-entry-RESTAPI\">\n\nOptional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String\n\n</td></tr></tbody>\n</table>|Name|Description|\n|----|-----------|\n|None| |\n\n<table class=\"rest_api_request_body\"><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nexception\n\n</td><td>\n\nRequired. Exception object containing the updated details. The **sys\\_id** and **in\\_office** fields are required.Data type: Object\n\n```\n\"exception\": { \n  \"date\": \"String\", \n  \"in_office\": Boolean,\n  \"location\": \"String\", \n  \"origin\": \"String\",\n  \"sys_id\": \"String\"\n}\n```\n\n</td></tr><tr><td>\n\nexception.date\n\n</td><td>\n\nDate of the exception.Format: yyyy-MM-dd\n\nData type: String\n\n</td></tr><tr><td>\n\nexception.in\\_office\n\n</td><td>\n\nRequired. Flag that indicates whether the user will be in the office on this date.Possible values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office.\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nexception.location\n\n</td><td>\n\nName or identifier of the office location for this exception.Data type: String\n\n</td></tr><tr><td>\n\nexception.origin\n\n</td><td>\n\nSource of the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\nDefault: user\n\n</td></tr><tr><td>\n\nexception.sys\\_id\n\n</td><td>\n\nRequired. Sys\\_id of the existing exception to update.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr></tbody>\n</table>### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Header|Description|\n|------|-----------|\n|Accept|Data format of the response body. Supported types: **application/json**, **application/xml**, or **text/xml**.|\n|Authorization|Authentication credentials. Supports Basic authentication or session-based authentication.|\n|Content-Type|Data format of the request body: application/json.|\n\n|Header|Description|\n|------|-----------|\n|Content-Type|Data format of the response body: application/json.|\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. Missing required fields sys\\_id or in\\_office.|\n|404|Not Found. The specified exception wasn't found or the user doesn't have permission to modify it.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n<table><thead><tr><th>\n\nName\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td>\n\nresult\n\n</td><td>\n\nObject containing results of the request.Data type: Object\n\n```\n\"result\": {\n    \"message\": \"String\",\n    \"result\": {Object}\n}\n```\n\n</td></tr><tr><td>\n\nresult.message\n\n</td><td>\n\nConfirmation message indicating the exception was updated. Data type: String\n\n</td></tr><tr><td>\n\nresult.result\n\n</td><td>\n\nContains the updated exception\\(s\\).Data type: Object\n\n```\n\"result\": {\n  \"exceptions\": [Array]\n}\n```\n\n</td></tr><tr><td>\n\nresult.result.exceptions\n\n</td><td>\n\nList of presence exceptions.Data type: Array of Objects\n\n```\n\"exceptions\": [\n {\n  \"sys_id\": \"sys_id\", \n  \"date\": \"String\", \n  \"in_office\": Boolean, \n  \"origin\": \"String\", \n  \"location\": \"String\" \n }\n]\n```\n\n</td></tr><tr><td>\n\nresult.result.exceptions.sys\\_id\n\n</td><td>\n\nSys\\_id of the exception record.Table: Employee presence exceptions \\(sn\\_wsd\\_concierge\\_employee\\_presence\\_exception\\)\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.date\n\n</td><td>\n\nDate this exception applies to, in yyyy-MM-dd format. This is the date the user's routine is being overridden.Data type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.in\\_office\n\n</td><td>\n\nFlag that indicates whether the user will be in the office on this date. This overrides whatever the weekly routine specifies for that day of the week.Valid values:\n\n-   `true`: User will be in the office.\n-   `false`: User won't be in the office\n\nData type: Boolean\n\n</td></tr><tr><td>\n\nresult.result.exceptions.origin\n\n</td><td>\n\nSource that created the exception.Valid values:\n\n-   `user`: Created manually by the employee.\n-   `system`: Created automatically by the platform.\n-   `manual`: Created by an admin or on behalf of the user.\n\nData type: String\n\n</td></tr><tr><td>\n\nresult.result.exceptions.location\n\n</td><td>\n\nThe name or identifier of the office location the user will be at on this date. Only relevant when `in_office` is `true`. May be an empty string when the user is remote.Data type: String\n\n</td></tr></tbody>\n</table>### cURL request\n\nThis example updates an existing exception to change the user’s status to remote \\(not in office\\) on the same date.\n\n```\ncurl \"https://<instance>.service-now.com/api/sn_wsd_concierge/v1/presence/exception\" \\\n--request PUT \\\n--header \"Accept: application/json\" \\\n--header \"Content-Type: application/json\" \\\n--user \"username:password\" \\\n--data '{\n  \"exception\": {\n    \"sys_id\": \"exc1a2b3c4d5e6\",\n    \"in_office\": false,\n    \"date\": \"2026-02-14\",\n    \"location\": \"\",\n    \"origin\": \"user\"\n  }\n}'\n```\n\nResponse body.\n\n**Note:** Because this endpoint cancels the original exception and creates a replacement, the returned `sys_id` differs from the one provided in the request.\n\n```\n{\n  \"result\": {\n    \"message\": \"Exception updated successfully\",\n    \"result\": {\n      \"exceptions\": [\n        { \"sys_id\": \"exc9k0l1m2n3o4\", \"date\": \"2026-02-14\", \"in_office\": false, \"origin\": \"user\", \"location\": \"\" }\n      ]\n    }\n  }\n}\n```\n\n"}}