PUT /api/public/objective/

Update one or more objectives.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
[] Array Yes
[].is_progress_aligned Boolean No

Allow a child objective's progress to impact any aligned parent objectives

[].parent_id Integer No

Objective's parent objective id

[].action String No

An action to be performed on the objective

Possible values:

  • "complete"
  • "delete"
  • "deactivate"
  • "reactivate"
[].description String No

Objective's description

[].viewable_by_users[] Array No

List of user ids who can view objective

[].scope String Yes

Objective's scope

Possible values:

  • "individual"
  • "self-development"
  • "group-type"
  • "company-wide"
[].start_ts String Yes

Objective's start date

[].end_ts String Yes

Objective's end date

[].id Integer Yes

Objective's ID

[].visibility String No

Objective's visibility

Possible values:

  • "public"
  • "report"
  • "custom"
[].viewable_by_groups[] Array No

List of group ids who can view objective

[].tags[] Array No

List of tags

[].user_id Integer Yes

Objective's owner id

[].group_id Integer No

Associated group id

[].color String No

Objective's status color

Possible values:

  • "yellow"
  • "red"
  • "undefined"
  • "green"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.