API Reference

Deletes a company work location.

delete
https://example.com/wep/companies//worklocations/

Access: System, Admin, and ClientAdmin users only.

Deletes the specified work location and applies the supplied delete options, including the effective date and optional replacement work location for current and future employee assignments.

The reserved work location identifier 0 (working from home) is not supported by this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from route.

int32
required

Work location identifier from route.

Body Params

Delete options including effective date and optional replacement work location for reassignment.

Payload that controls deletion of a work location and optional reassignment of affected employees.

int32 | null

Optional replacement work location identifier for employees currently or prospectively assigned to the deleted location. Leave null or 0 to remove the location without assigning a replacement.

date-time

Effective date passed to the business layer when deleting the work location and reassigning affected employees.

Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
204

The work location was deleted successfully.

Updated about 1 month ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/json
text/plain

Updated about 1 month ago