API update methods

https://eu.okr-jira-prod.appfire.comThe base url for all API calls is:

if you are in EU region:
https://eu.okr-jira-prod.appfire.com

everywhere else:
https://okr-jira-prod.appfire.com

Prerequisites

All update methods are POST, and require JSON object with specified properties in body of the request.
Authentication is performed in the same way, as for query methods - using API-Token: {token} header with your authentication token.
Also Content-Type: application/json header is mandatory for server to correctly parse your request.

Update objective

Create update for specified objective with.

POST /api/v2/api-update/objectives

Property	Description	Mandatory

Property	Description	Mandatory
`objectiveId`	Id of objective to update.
`status`	New state of the objective. Allowed statuses: `NOT STARTED`, `ON TRACK`, `AT RISK`, `OFF TRACK`
`description`	A description to appear on created update.

Example request:

POST https://okr-jira-prod.appfire.com/api/v2/api-update/objectives
Request body:

{
  "objectiveId": "62334eac00ee2b102e34fdb7",
  "status" : "ON TRACK",
  "description" : "Spaceship assembly docks are delivering on time"
}

curl -X POST https://okr-jira-prod.appfire.com/api/v2/api-update/objectives \
-H 'Content-Type: application/json' \
-H 'API-Token: {token}' \
-d '{"objectiveId":"62334eac00ee2b102e34fdb7", "status":"ON TRACK", "description":"Spaceship assembly docks are delivering on time"}'

{
	"entityId": "62334eac00ee2b102e34fdb7",
	"status": "ON TRACK",
	"created": "2022-05-20T09:58:09+0000",
	"value": null,
	"description": "Spaceship assembly docks are delivering on time"
}

Update key result

Create update for specified key result.

POST /api/v2/api-update/keyResults

Property	Description	Mandatory

Property	Description	Mandatory
`keyResultId`	Id of key result to update.
`status`	New state of the key result. Allowed statuses: `NOT STARTED`, `ON TRACK`, `AT RISK`, `OFF TRACK`
`newValue`	Progress value to set in update. Can not be set for auto key results, as their value comes from JQL query. In case KR progress unit is currency, value should still be a number, without currency symbol.
`description`	A description to appear on created update.

Example request:

POST https://okr-jira-prod.appfire.com/api/v2/api-update/keyResults

Request body:

OKRs for Jira

This site is moving soon to become part of an integrated Appfire documentation and information site for our apps. This site will remain available during the transition to our new and improved site. Once this site is moved over, this banner will be updated with the new site link for easy access.

API update methods

Prerequisites

Update objective

Update key result

Related pages