Create Goal
Goals
Create Goal
Create a new goal. Supports up to 3 active goals; the oldest is deactivated if at max.
- title: The goal title/description (1-500 characters)
- goal_type: Type of goal metric: boolean, scale, or numeric (default: scale)
- target_value: Target value to achieve
- current_value: Current progress (default: 0)
- min_value: Minimum scale value (default: 0)
- max_value: Maximum scale value (default: 10)
- unit: Optional unit label (e.g., ‘users’, ‘points’)
POST
Create Goal
Authorizations
Send Authorization: Bearer <omi_developer_api_key>.
Body
application/json
Target value to achieve
The goal title/description
Required string length:
1 - 500Current progress value
Type of goal metric: boolean, scale, or numeric
Available options:
boolean, scale, numeric Maximum value of the scale
Minimum value of the scale
Unit label (e.g., 'users', 'points')
Response
Successful Response