Update a location by ID

put

https://api.talkdeskapp.com/locations-directory/locations/{location_id}

Updates the location identified by the location_id path parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Scope

locations-directory:write

Path Params

location_id

string

required

length ≥ 1

The location id

Body Params

The location to update

name

string

required

length ≥ 1

The name of the location

alternative_names

array of strings

The alternative names of the location

alternative_names

external_id

string

length ≥ 1

The external id of the location

type

string

length ≥ 1

The type of the location

time_zone

string

required

length ≥ 1

The time zone of the location, according to IANA.

phone_numbers

array of objects

phone_numbers

image_url

string

length ≥ 1

The URL of an image of the location

address

object

required

Represents the address of a location

opening_status

string

enum

length ≥ 1

The status of the location, if it is opened or closed

Allowed:

services

array of objects

The list of services

services

staffs

array of objects

required

Defaults to []

The list of staff members assigned to this location.

staffs*

open_hours

array of objects

open_hours

special_dates

array of objects

special_dates

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Scope

200Location successfully updated

400Bad Request

401Unauthorized

403Forbidden

404Location not found