Remove Filter As Favorite
DELETE {{baseUrl}}/rest/api/3/filter/:id/favourite?expand=<string>
Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user's favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.
Permissions required: Permission to access Jira.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
expand | string | Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: |
sharedUsersReturns the users that the filter is shared with. This includes users that can browse projects that the filter is shared with. If you don't specifysharedUsers, then thesharedUsersobject is returned but it doesn't list any users. The list of users returned is limited to 1000, to access additional users append[start-index:end-index]to the expand request. For example, to access the next 1000 users, use?expand=sharedUsers[1001:2000].subscriptionsReturns the users that are subscribed to the filter. If you don't specifysubscriptions, thesubscriptionsobject is returned but it doesn't list any subscriptions. The list of subscriptions returned is limited to 1000, to access additional subscriptions append[start-index:end-index]to the expand request. For example, to access the next 1000 subscriptions, use?expand=subscriptions[1001:2000]. |
RESPONSES
status: OK
{"self":"https://your-domain.atlassian.net/rest/api/3/filter/10000","id":"10000","name":"All Open Bugs","description":"Lists all open bugs","owner":{"self":"https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g","key":"","accountId":"5b10a2844c20165700ede21g","name":"","avatarUrls":{"48x48":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48\u0026s=48","24x24":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24\u0026s=24","16x16":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16\u0026s=16","32x32":"https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32\u0026s=32"},"displayName":"Mia Krystof","active":false},"jql":"type = Bug and resolution is empty","viewUrl":"https://your-domain.atlassian.net/issues/?filter=10000","searchUrl":"https://your-domain.atlassian.net/rest/api/3/search?jql=type%20%3D%20Bug%20and%20resolutino%20is%20empty","favourite":true,"favouritedCount":0,"sharePermissions":[],"subscriptions":{"size":0,"items":[],"max-results":0,"start-index":0,"end-index":0}}