For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Integration Example (PSA)
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
      • GETGets all absence regions.
      • POSTCreates a new absence region.
      • GETList of supported countries for absence regions.
      • GETList of locations for a country.
      • POSTAssign/remove current user to/from an absence region.
      • PUTAssign/remove current user to/from an absence region.
      • POSTAssigns or unassigns users to/from an absence region.
      • PUTAssigns or unassigns users to/from an absence region.
      • GETGet an absence region by id.
      • PUTUpdates an absence region.
      • DELDeletes an absence region.
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Workflows Overview
    • Login & Access Overview
    • API Management Overview
LogoLogo
SupportDeveloper ForumLogin
API v1 ReferenceAbsence Regions

Assigns or unassigns users to/from an absence region.

Deprecated
PUT
https://api.awork.com/api/v1/absenceregions/users/assign
PUT
/api/v1/absenceregions/users/assign
$curl -X PUT https://api.awork.com/api/v1/absenceregions/users/assign \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "userIds": [
>    "7b356284-d22b-4f74-980d-0a548d3b6318",
>    "b37f07dd-6644-4271-9c8a-bb700cc21b63"
>  ],
>  "regionId": "123e4567-e89b-12d3-a456-426614174000"
>}'
A user can be assigned to only one absence region. If a user is already assigned to an absence region, they will be removed from the previous one and assigned to the new one. Providing an empty list of user ids will remove all users from the absence region. <Check title="Required Permissions" icon="key">The user must be an admin or have `user-planning-data:write` permissions.</Check>
Was this page helpful?
Previous

Get an absence region by id.

Next
Built with

A user can be assigned to only one absence region. If a user is already assigned to an absence region, they will be removed from the previous one and assigned to the new one. Providing an empty list of user ids will remove all users from the absence region.

Required Permissions
The user must be an admin or have user-planning-data:write permissions.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The model to assign or unassign users to/from an absence region.

userIdslist of stringsRequired
The list of userIds to assign to that region. Providing an empty list of user ids will remove all users from the absence region.
regionIdstringRequiredformat: "uuid"
The id of the region to assign the users to.

Response

No Content

Errors

400
Bad Request Error
404
Not Found Error