PUT
/goal_relationships/{goal_relationship_gid}Update a goal relationship
Updates an existing goal relationship and returns the complete updated record. Supply the fields to change in the data block; fields you omit retain their existing values, and use opt_fields to include optional response properties.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
opt_fieldsarray<string>optional
Comma-separated response properties to include, including supported nested fields such as `supported_goal.name` and `supporting_resource.resource_subtype`. Values must be selected from the documented optional properties.
The fields to update on the goal relationship, wrapped in a data object; omitted fields remain unchanged.
dataobjectoptional
An object containing the goal relationship properties to update.
200Returns the complete updated goal relationship record.
dataobjectoptional
400Returned when a parameter or request body is missing or malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the goal relationship or requested properties.
errorsarray<object>optional
404Returned when the goal relationship does not exist or the request does not identify a known action.
errorsarray<object>optional
500Returned when a server-side problem prevents the update from completing.
errorsarray<object>optional
Error handling
A 400 is returned when a parameter or request body is missing or malformed. A 401 is returned without valid authentication, and a 403 is returned when the authenticated user lacks access. A 404 indicates that the goal relationship does not exist, while a 500 indicates a server-side failure; include only valid properties in data and opt_fields.