Positions

Positions in Zoho Shifts can be used to define job role or title.

End Points

GET

/settings/positions

POST

/settings/positions

PUT

/settings/positions/{position_id}

DELETE

/settings/positions/{position_id}

Get all positions

List all positions in an organization.

Required OAuth Scope: ZohoShifts.settings.READ

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/positions
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

{
    "positions": [
        {
            "id": "714000000002029",
            "name": "Barista",
            "color": "blue",
            "schedules": [
                {
                    "id": "714000000002029",
                    "name": "Midtown"
                }
            ]
        }
    ]
}

Create a position

Required OAuth Scope: ZohoShifts.settings.CREATE

Arguments

name

string

(Required)

color

string

Default value: blue
Allowed values: red, pink, magenta, purple, deep-purple, indigo, light-violet, blue, light-blue, cyan, muted-green, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown, grey, blue-grey

schedules

array

Show Sub-Attributes

string

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/positions
-X POST
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'

{
    "name": "Barista",
    "color": "blue",
    "schedules": [
        {
            "id": "714000000002029"
        }
    ]
}

{
    "id": "714000000002029",
    "name": "Barista",
    "color": "blue",
    "schedules": [
        {
            "id": "714000000002029",
            "name": "Midtown"
        }
    ]
}

Update a position

Required OAuth Scope: ZohoShifts.settings.UPDATE

Arguments

name

string

color

string

schedules

array

Show Sub-Attributes

string

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/positions/{position_id}
-X PUT
-H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"
-d '{"field":"value","field":"value"}'

{
    "name": "Barista",
    "color": "blue",
    "schedules": [
        {
            "id": "714000000002029"
        }
    ]
}

{
    "id": "714000000002029",
    "name": "Barista",
    "color": "blue",
    "schedules": [
        {
            "id": "714000000002029",
            "name": "Midtown"
        }
    ]
}

Delete a position

Required OAuth Scope: ZohoShifts.settings.DELETE

$ curl https://shifts.zoho.com/api/v1/{org_id}/settings/positions/{position_id}
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.41d9f2cfbd1b7a8f9e314b7aff7bc2d1.8fcc9810810a216793f385b9dd6e125f"

{
    "message": "Position deleted"
}