API Reference

Creates a company work location.

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

Access: System, Admin, and ClientAdmin users only.

Creates a new company work location from the supplied code, name, and address fields.

If address validation can suggest a payroll-valid correction, the request fails with HTTP 400 and returns Worklio.ApiModels.API.Models.Clients.Address.AddressFix_v10 instead of creating the location.

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

Company identifier from route.

Body Params

Payload describing the work location to create, including code, name, and address fields.

Payload for creating a company work location.
Inherits required address fields from Worklio.ApiModels.API.Models.Clients.Address.AddressCreate_v10.

string | null
required

Primary street-address line.

string | null

Secondary street-address line, such as suite, unit, or apartment.

string | null
required

City name for the address.

string | null

State, province, or region code.

string | null
required

Postal or ZIP code.

string | null

Two-character country code. Defaults to US when omitted.

double | null

Geographic latitude for the address, when available.

double | null

Geographic longitude for the address, when available.

string | null
required

Business code for the work location. Required. Maximum length is 20 characters.

string | null
required

Display name of the work location. Required. Maximum length is 100 characters.

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

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