Refresh Channel Health
POST/api/channel-health/refresh
Requests fresh seller-performance numbers from the marketplaces as a background job, for one integration instance or (with integration_instance_id null) every monitored instance. Marketplaces update these numbers about once a day, so each instance can be refreshed at most once an hour; refreshing everything skips instances refreshed within the hour.
channel-health:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Responds 202 with the background job's tracked_job_log_id, the instances being refreshed and when they may be refreshed again. Responds 429 with a Retry-After header (seconds) and next_available_at when every targeted instance was refreshed less than an hour ago, and 422 when the instance isn't monitored by Channel Health.
Authentication: Bearer token (Personal Access Token) with the channel-health:write scope. The user needs the Integrations › Sync permission.
Request
Responses
- 202
- 401
- 403
- 422
- 429
Accepted
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.
Unprocessable Entity
Response Headers
Too Many Requests