API Documentation

POST /objectives

Creates a new objective in ProdPad. The data for the objective needs to be passed as a JSON object within the post body. The account and user access rights are determined by the API key.

Resource URL

POST https://api.prodpad.com/v1/objectives

Post body

Fields

name

type

required

Description

name

string

Yes

Name of the new objective.

state

string

No

The state of the objective i.e. “active” or “archived”.

product

integer

No

The id of the product to which the objective will be added, if null the objective will be added as a global objective.

 

Payload

{
"name" : "POST Objective",
"state" : "active",
"product" : {
"id" : 1
}

}

 

Response

Status : 201 Created

{
   "id": "a44af788-6758-4ea2-a4a6-e0bb2f5562d9",
   "name": "POST Objective",
   "state": "active",
   "product": {
       "id": 1
   },
   "created_at": "2019-03-06 15:58:35",
   "updated_at": "2019-03-06 15:58:35"
}

Notes

  • All dates are in UTC.
  • Product specific objectives can only be created for accounts on an Advanced plan or higher.
  • If an account is on an Advanced plan or higher, only API keys for an account admins can create global objectives.

Comments