Sample - Asana API
POST/goals/{goal_gid}/addCustomFieldSetting

Add a custom field to a goal

Adds a custom field setting to a goal. Supply the custom field in custom_field and optionally control its importance or position with is_important, insert_before, and insert_after. You must have the goals:write scope to perform this operation.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 body field

Information about the custom field setting to add to the goal.

dataobjectoptional
The custom field setting configuration.

6 status codes
200Returns the custom field setting added to the goal.
dataobjectoptional
400Returned when the `custom_field` value is missing or a request value is malformed, including when both `insert_before` and `insert_after` are supplied.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
403Returned when the authenticated user lacks access or the `goals:write` scope.
errorsarray<object>optional
404Returned when the request does not specify a known action or the specified object does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the custom field setting from being added.
errorsarray<object>optional

Error handling

The custom_field field is required. Do not provide both insert_before and insert_after; use at most one positioning reference. A 400 is returned for a missing or malformed value, a 401 for missing authentication, a 403 without access or the goals:write scope, a 404 for an unknown action or object, and a 500 for a server-side failure.