API Reference

Create a goal

post
https://api.talent.performyard.com/v1/goals

Creates a new goal for the specified assignees. Please note, just like when creating a new goal in the PerformYard interface, adding multiple goal assignees will not assign multiple users to a single goal and will instead create one goal each for every assignee included.

Body Params
string
required
length between 4 and 280

Name of the goal being created.

assignment
array of strings
required
length between 1 and 50

The user ID(s) of the employee(s) that will be assigned the goal being created.

assignment*
string
required

Defines who can see the goal being created.

number
required

The value you want to hit for the goal being created.

string

The type of units the goal being created will have for its target.

date
required
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

The start date of the goal. Accepted Format: YYYY-MM-DD.

date
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Defines when the goal is due. Accepted Format: YYYY-MM-DD.

boolean
Defaults to false

Defines whether the goal is a top level goal or not.

string

The details of the goal being created.

categories
array of strings

Defines the category or categories that the goal being created belongs to. Accepts an array of goal category IDs (strings). Goal categories can be retrieved using the GET /v1/goal-categories endpoint. If your organization has enabled the "Require goal category when creating or editing goals" setting, categories becomes a required field.

categories
number
> 0

Defines the weight of the goal being created compared to other goals assigned to the same employee.

string

Defines the goal that the goal being created is aligned to. Must be a different goal's ID. Only a single goal ID is valid.

boolean
Defaults to false

Defines whether the goal's progress can be updated by its checklist.

Responses

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?