This section contains API details that are common to every API’s resource, method and action.

Request Headers

Header Description Notes
Authorization Contains token string to allow request authentication and authorization.  
If-Match Contains data revision, as known by the client. Allows optimization of backend, networking and client resource utilization.

Response Headers

Header Description Notes
ac-revision Account config object type collection revision.  

Query Parameters

Name Description Type Required Notes
v API version Double Required Validation fail error code: 400
select Dynamic selection of the response fields. YOGA 'gdata' dialect. Optional Validation error: 400 Non-existing field: no error, blank in response. Supported fields: any in response body

Path Parameters

Parameter Description Type Notes
accountId LP site ID string Validation fail error code: 400

Entity Structure

Attribute Description Required Type Notes
name Workday/special occasion Object's name Yes String This must be a unique nameMax length: 50
description Workday/special occasion Object's description Yes String Max length: 200
deleted whether the items is deleted or not No Boolean
isDefault Whether the object is set as the default object for the account Yes Boolean
events A list of events listing the object's attributes/options Yes Array
start A set of attributes defining the start time and date of the object Yes Object
  • This array receives two possible fields:
    -dateTime
    -timezone
  • Valid formats are either without hours (yyyy-MM-dd) or with hours (yyyy-MM-dd'T'HH:mm:ss). If no hour specified, 24/7 is assumed.
  • The timezone field for both the start and end array must match. Only LiveEngage supported timezones may be used.
end A set of attributes defining the end time and date of the object Yes Object
  • This array receives two possible fields:
    -dateTime
    -timezone
  • Valid formats are either without hours (yyyy-MM-dd) or with hours (yyyy-MM-dd'T'HH:mm:ss). If no hour specified, 24/7 is assumed.
  • The timezone field for both the start and end array must match. Only LiveEngage supported timezones may be used.
recurrence This is mandatory both for workdays and special occasion. Workdays must include single recurrence. Special occasion can include either a single recurrence or an empty list. Yes Array The recurrence must comply with the following pattern: "^RRULE:FREQ=DAILY;COUNT=[1-9][0-9]*;INTERVAL=1$"
In case meta.working is set to false, recurrence must be lower or equal to 30
meta Contains meta data important for the special occasions object Yes Object This array contains two fields:
  • working. This field indicates whether agents are working during this event (and thus the special occasion is just a change of working hours) or whether agents aren't working (a day off). This field is boolean and required
  • name. The name of the special occasion's event. This field is a string and is required.

Special Occasion Object Description

{
    "deleted": false,
    "name": "special occasion 1",
    "description": "Description for workdays 1",
    "isDefault": false,
    "events": [
        {
            "meta": {
                "working": true,
                "name": "user1"
            },
            "start": {
                "dateTime": "2017-03-27T06:00:00",
                "timeZone": "Europe/Zurich"
            },
            "end": {
                "dateTime": "2018-03-27T13:00:00",
                "timeZone": "Europe/Zurich"
            },
            "recurrence": []
        }
    ]
}