Request

PATCH https://api.eloomi.com/v3/goals/{maingoalId}/{subgoalId}

Path parameters

Parameter name Value Description Additional
maingoalId integer

Id of the maingoal

Required
subgoalId integer

Id of the subgoal

Required

Request headers

Parameter name Value Description Additional
ClientId string

Provided by eloomi

Required
Authorization string

Look in the documentation for the authentication endpoint on how to construct this

Required

Request body

[
    {
        "employee_ids": [
            "integer"
        ],
        "expected": "number",
        "user_ids": [
            "integer"
        ],
        "weight": "number"
    }
]

Properties

Name Example Description Additional
employee_ids[] [ "E1234", "E4321" ]

The employee ids of the users that should have this assigned

Optional
expected 2.5

The target to hit for this subgoal

Optional
user_ids[] [ 1, 2 ]

The eloomi ids of the users that should have this assigned

Optional
weight 1

The weight of the goal relative to the other subgoals

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Subgoal updated

SubgoalUpdateSuccess
400 Bad Request

Request contained invalid data

GenericSuccess
401 Unauthorized

Not allowed

ErrorSuccess