Skip to main content
PUT
Replace the list of suppliers switched off
Replaces the list of suppliers switched off for your account. Send the whole list each time: the numbers you send are off, everything else is on. An empty array switches every supplier back on. The change takes effect on your next request. It applies to listings, depth, prices, both snapshots and the stream. Take the numbers from GET /v1/sources.
This is a filter on what you are shown, not a block on buying. A listing id you send to POST /v1/orders is bought whatever its supplier.
Authentication required. Send your key as Authorization: Bearer csb_pub_....

Body

integer[]
required
Supplier numbers to switch off. A number that is not in use is refused, so a typo cannot silently switch nothing off.

After a change

  • Stream. A connection keeps the list it was opened with. Reconnect to apply the new one, and delete the listings of the suppliers you switched off from your copy: their gone will not arrive.
  • Snapshots. The listings snapshot is built per list. A list nobody has used before answers 202 snapshot_building until its file is ready.

Example request

Example response

Error codes

Authorizations

Authorization
string
header
required

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile. Calls made with a key are metered only by that key's own limits — there is no per-IP limit on top — and every answer carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-RateLimit-Bucket for the bucket the call spent. See Rate limits.

Body

application/json
sources_off
integer[]
required

Supplier numbers to switch off, from GET /sources. A number that is not in use is refused.

Response

Saved.

data
object