Targets & Blacklist

Set the shop's performance targets for several granularities

Convenience fan-out of PUT /targets — set weekly, monthly and quarterly goals in one request instead of three. Each entry is upserted exactly as the single-granularity route does, and each granularity may appear only once.

NOT atomic: entries are applied in order and an invalid one aborts the request, leaving earlier entries already written. Re-sending the whole payload after fixing the bad entry is safe — writes are upserts. Requires a key with read_write scope and a single shop.

post/targets/bulk

Request body

Example request

{
  "targets": [
    {
      "granularity": "monthly",
      "targets": {
        "creators_messaged": 200,
        "target_collabs": 50,
        "videos_posted": 35
      }
    }
  ]
}

Response

Successful Response

Example response

{
  "results": [
    {
      "target": {
        "created_at": "2024-01-01T00:00:00Z",
        "customer_id": 924,
        "granularity": "monthly",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "shop_id": 1183,
        "targets": {
          "creators_messaged": 200,
          "sample_approved": 80,
          "sample_requests": 100,
          "spark_codes": 10,
          "target_collabs": 50,
          "videos_converted": 25,
          "videos_posted": 35
        },
        "updated_at": "2024-01-01T00:00:00Z"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.