Dismiss Channel Health Flag
PATCH/api/channel-health/flags/:flag/dismiss
Dismisses an open flag with an optional note. A dismissed flag stays in history but no longer counts as needing action; the marketplace may still count the shipment.
channel-health:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns 422 with reason = not_open when the flag is already closed.
Authentication: Bearer token (Personal Access Token) with the channel-health:write scope. The user needs the Integrations › View permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.