Magidoc

updateGoal
Mutation

Update an existing goal - follows the same validation rules as createGoal

See createGoal mutation for complete validation rule documentation. Key validation reminders:

  • actionIds require: measurementType actions/overdue + measurementUnit actions + measurementUnitValue 'actions'
  • projectIds require: measurementType actions/overdue + measurementUnit projects + measurementUnitValue 'projects'
  • Date combinations: Cannot mix ongoingDate + recurringDate, or ongoingDate/recurringDate + startDate/endDate
  • measurementUnit + measurementUnitValue + measurementUnitSymbol must match allowed combinations

Arguments

#

_id

ID !
Non-null

Goal ID to update

name

Goal name (cannot be empty string if provided)

initialValue

Initial numeric value

currentValue

Current numeric value

goalValue

Target numeric value

actionIds

[ ID !]

Action IDs to track (requires measurementType actions/overdue + measurementUnit actions + measurementUnitValue 'actions')

includeSubActions

Whether to include sub-actions in tracking

projectIds

[ ID !]

Project IDs to track (requires measurementType actions/overdue + measurementUnit projects + measurementUnitValue 'projects')

parentId

Parent goal ID

description

Goal description in HTML format

owners

[ ID !]

User IDs who own this goal

teamOwners

[ ID !]

Team IDs who own this goal

startDate

Start date (requires endDate, cannot combine with ongoingDate/recurringDate)

endDate

End date (must be after startDate, cannot combine with ongoingDate/recurringDate)

ongoingDate

Whether goal is ongoing (cannot combine with recurringDate or dates)

recurringDate

Recurring schedule (cannot combine with ongoingDate or dates)

includeSubGoals

Whether to include sub-goals

status

Goal status

statusDetails

Status details/notes

measurementType

How goal value is measured - affects which measurementUnit values are valid

measurementUnit

Unit for measurement - must match measurementType rules

measurementUnitValue

Specific value for unit - must match measurementUnit (e.g., 'USD', 'actions', 'projects')

measurementUnitSymbol

Symbol for unit - must match measurementUnitValue (e.g., '$', '%')

displayType

How goal is displayed - must match measurementType rules

statusUpdateMode

Status update mode

statusUpdateRange

Status update range rules

rankInput

Ranking input for goal positioning

recurringUpdateReminder

Recurring update reminder settings

sharingType

Who can access this goal

sharingWith

[ ID !]

User IDs to share with (only valid when sharingType is custom)

isAutomated

Whether this goal was created/updated automatically

Response

#

Returns Goal .

Example

#

    
  

3

    
  

3

    
  

3