Skip to main content
POST
Create a utilization target period
A period defining a member’s billable utilization targets.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
start
string<date>
required

The start date for the period. Must be in the form YYYY-MM-DD.

memberId
string
required

The member ID (uuid) for this utilization target period.

targetPercentage
number | null

The target billable utilization percentage for this period. Must be between 0 and 999.99.

Response

200

id
string

The unique identifier for the object.

start
string<date>

The start date for the period. Will be in the form YYYY-MM-DD.

targetPercentage
number | null

The target billable utilization percentage for this period.

createdAt
string<date-time>

The timestamp when the object was created.

isDefault
boolean

Whether this is the default utilization target period for the member.

end
string<date> | null

The end date for the period. Will be in the form YYYY-MM-DD. null if the period has no end date.