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

Request Headers

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

Response Headers

Header Description
eTag This parameter specifies the version of the data object retrieved. You can use the If-Match parameter in the request to retrieve a specifc version using this parameter's value.
location URI Location of the newly created resource. This header is included only when the request created single object.

Query Parameters


Parameter Description Notes
v API version number Type: Double. Default Value: 1.0 (Most updated: v=4.0). Validation fail error code: 400


Parameter Description Notes
select Dynamic selection of the response fields YOGA 'gdata' dialect. Non-existing field: No error, blank in response. Supported fields: any in response body. **yoga GData dialect builder URL: There is a known issue with merging nested properties like hotkey(prefix),hotkey(suffix), the result is only hotkey(suffix) and not both. See
include_deleted Whether to include deleted items in the response or not Default: false

Path Parameters

Parameter Description Type
accountId LP site ID String
userId user ID Positive long number greater than zero
skillId skill ID Positive long number greater than zero
agentGroupId agent group ID Positive long number greater than zero

Entity Structure

Read only:

Attribute Description Type/Value
id Account Config object’s unique ID. long number
deleted Whether or not the item is deleted boolean


Attribute Description Type/Value  
name The agent group’s unique name. string  
parentGroupId The agent group’s parent group. Root agent group is the only group that has null parentGroupId. Note: Required if at least 1 agent group exists. number
isEnabled Whether or not the agent group is enabled. boolean  


Attribute Description Type/Value    
description The agent group’s description. string    
dateUpdated The last update user change date. Date (numbers) Optional The format: year-month-date hrs:min:sec

Entity Example

        "id": "1231234",
        "deleted": "false",
        "name": "newAgentGroup1",
        "description": "a new group of agents",
        "parentGroupId": "1",
        "isEnabled": "true"

Data Revisions

The revision mechanism exists in order to maintain order and save historical data. To use the benefits of the revision mechanism, The developers are asked to add the 'IF-MATCH' request header. The 'IF-MATCH' request header contains data revision as known by the client, In addition, it allows to optimize the backend response and allows concurrent modification backend verification.

Every entity will have only one latest revision and the maximum revision number is a global number by account. Each change/update on one of these entities increases The revision. The developer can call the GET entity API in order to retrieve the latest revision. This revision will be part of the response header under ac-revision header.

When sending the API calls using the 'IF-MATCH' header with a specific revision if there was no change the response will be 304 (Not Modified) response. When using 'IF-MATCH' header with '-1' value you will always get the full response.