Create Objective

POST /v2/partner/objectives

Required scopes

partner:objectives:write

Tokens missing any required scope return 401 scope_missing. See Auth & Scopes for issuance.

Operation

Operation ID	`createObjective`
Tags	Outcomes

Request body

Required

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`objective`
team_id *	id	UUID v4.
name *	string
key *	string
description	string
benchmark	number
benchmark_kind	enum (2)	`ratecount`
driver_id	string (uuid)
value_cents	integer
is_archived *	boolean
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
template_ids *	id[]

Responses

201

Created

object

Field	Type	Description
id *	id	UUID v4.
type *	enum (1)	`objective`
team_id *	id	UUID v4.
name *	string
key *	string
description	string
benchmark	number
benchmark_kind	enum (2)	`ratecount`
driver_id	string (uuid)
value_cents	integer
is_archived *	boolean
inserted_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
updated_at *	updated_at	RFC 3339 / ISO 8601 timestamp.
template_ids *	id[]

Example request

POST https://api.digitalonboarding.com/v2/partner/objectives
Authorization: Bearer <partner-token>
Content-Type: application/json
Idempotency-Key: <uuid-v4>

{ /* request body matching schema above */ }