Goal Model

Represents a goal a user on the Capsule account is working towards. Goals can be broken down into multiple goal periods, each representing a duration of time as specified by the goal frequency field as detailed below.

Name Type Description
id Long Read only

The id of this goal.
name String Required

The name of this goal.
frequency String Required

The frequency of goal periods this goal will be broken down into.

Accepted values are: DAILY, WEEKLY, MONTHLY, YEARLY, FIXED
startOn Date Required

The start date of this goal.
endOn Date Required

The end date of this goal.
type String Required

The type of this goal. Accepted goal type ID values are:

  • 7b05186c-c342-343f-8236-121dfbb2ae45 - Opportunities created sum
  • 18305eb9-2c50-35ba-88e5-876be543e055 - Opportunities created count
  • bbc7a4b4-78eb-3bbd-85bb-9f20ec2e3f5d - Opportunities won sum
  • 264be3b0-490b-3d73-ae0d-d02b488ba1eb - Opportunities won count
  • 1659cb58-2401-30eb-aa82-c42771aea74e - Opportunities reached milestone count
value Double Required

The value of this goal. Has to be an integer if goal type is a count (rather than sum).
currency String

The currency the goal value will be tracked in. Required if the type is sum (rather than count), otherwise set to null. Follows the ISO 4217 currency code standard.
user Nested User Required

The user this goal is assigned to.
status String Read only

The status of this goal.

Accepted values are: UPCOMING, ACTIVE, COMPLETED, MISSED
pipeline Nested Pipeline

The pipeline this goal belongs to. Note that only one of milestone or pipeline can be not null.
milestone Nested Milestone

The milestone this goal belongs to. Note that only one of milestone or pipeline can be not null.
createdAt Date Read only

The ISO date/time when this goal was created.
updatedAt Date Read only

The ISO date/time when this goal was last updated.