API Reference
HomeLOGIN

Update resource

patch
https://api.timify.com/v1/resources/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the resource.

Query Params
string
enum

The "external" attribute specifies if the search query will use the external or TIMIFY ID. When "external" is set as 1, "resourceId" is used as the "externalId", alternatively the "resourceId" is the TIMIFY id.

Allowed:
Body Params
string
required

Name of the resource.

string

External Id of the resource

permissions
object

Resource permissions, whether a resource is permitted to create, fetch, update or delete.
Email of the resource is required for permissions
Example:

{
  "accountRead": true,
  "calendarReadSet" : {
    "specificResourceIds": ["id1", "id2"]
  }
}

Available permissions:

  • accountRead: Boolean
  • calendarReadSet: Object of:
    • specificResourceCategoryIds: [ID]
    • specificResourceIds: [ID]
  • calendarWrite: Boolean
  • calendarDelete: Boolean
  • statisticsRead: Boolean
  • notificationsRead: Boolean
  • customersReadSet: Object of:
    • specificResourceCategoryIds: [ID]
    • specificResourceIds: [ID]
  • customersWrite: Boolean
  • customersDelete: Boolean
  • appsRead: Boolean
  • resourcesReadSet: Object of:
    • specificResourceCategoryIds: [ID]
    • specificResourceIds: [ID]
  • shiftRead: Boolean
  • shiftWrite: Boolean
  • shiftDelete: Boolean
string

Email of the resource

booking_times
array of objects
length between 7 and 7

Select time intervals when a resource is available for appointments. It is mandatory to define an object for each day of the week starting with Sunday.
Structure: active - BOOL is the resource available on the day for appointments. times - ARRAY of objects with booking time intervals.

{
  "active": true,
  "times": [
    { "from": "09:00", "until": "13:00" },
    { "from": "14:00", "until": "18:00" }
  ]
}

The resource will be UNAVAILABLE between 13:00-14:00 and bookable from 09:00-13:00 and 14:00-18:00

booking_times
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
working_times
array of objects
length between 7 and 7

Define a resource work day. It is mandatory to define an object for each day of the week starting with Sunday.
Structure: active - BOOL is the resource available on the day for appointments. times - ARRAY of objects with booking time intervals.

{
  "active": true,
  "times": [
    { "from": "09:00", "until": "13:00" },
    { "from": "14:00", "until": "18:00" }
  ]
}

The resource will be UNAVAILABLE between 13:00-14:00 and bookable from 09:00-13:00 and 14:00-18:00

working_times
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
boolean
required
times
array of objects
required
times*
string

Id of resource category

string

External id of resource category

string
enum

The Color of the resource in HEX format.

string

Avatar of the resource. You need to send the image file in base64 encoding. Example:

data:image/png;base64,iVBORw...
boolean

Activate resource for online booking. This parameter can be used only if the parameter email is set.

boolean

Is the resource administrator or not.
This parameter can be used only if the parameter email is set.

boolean

Should the resource be invited as an account (value = true) or not? If yes - the resource will have login credentials and will receive an invitation email.
If the value is true the parameter email is required
The default value is false

string
attributes
array of objects

Define customizations fields for your resource.
Either id or external_id is required.
Either value or values is required.
WARNING: Passing attributes in the request body will overwrite the default value/s on the attribute for this resource.
If you wish to keep the default configuration of the attributes, do not provide attributes in the request body.
Example data in request:

[
  {
    "id": STRING, // or external_id
    "external_id": STRING, // or id
    "value": STRING, // or values
    "values": ARRAY // or value
  }
]
attributes
availabilityDisplayConfig
object
string
enum

Default timezone is UTC

Headers
string
required

Id of the company

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?