POST
/goals/{goal_gid}/removeFollowersRemove collaborators from a goal
Removes one or more followers from a goal. Supply the users to remove in the followers array within the data object, using me, an email address, or a user GID for each entry. A successful response returns the complete updated goal record.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
opt_fieldsarray<string>optional
A comma-separated list of optional goal properties to include in the response, including nested properties. Omit this parameter to use the default response fields.
The followers to remove as collaborators, supplied in the data object.
dataobjectoptional
The payload containing the `followers` array.
200Returns the complete goal record after the followers are removed as collaborators.
dataobjectoptional
400Returned when the `followers` field is missing or the request is malformed.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
402Returned when the requested follower operation exceeds the authenticated user's current premium level.
errorsarray<object>optional
403Returned when the authenticated user does not have access to modify the goal.
errorsarray<object>optional
404Returned when the request does not specify a known action or the specified goal does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the followers from being removed.
errorsarray<object>optional
Error handling
The followers field is required and must contain an array of user identifiers; each value must be me, an email address, or a user GID. A 400 is returned for a missing or malformed request, and a 401 is returned without valid authentication. A 402 indicates that the operation exceeds the current premium level, 403 indicates insufficient access, 404 indicates an unknown action or object, and 500 indicates a server-side failure.