> ## Documentation Index
> Fetch the complete documentation index at: https://www.getsoundlink.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update campaign tier allocation

> Enable or disable geographic tiers and optionally reallocate budget
shares for a wallet campaign.

**Wallet campaigns only** (`generation: 3`).

**Request rules:**
- Include **all** tiers on the campaign in `items`
- `newAllocationPercent` values must sum to **100**
- At least one tier must have `isEnabled: true`

**Cooldown:** after a successful update, further tier changes are
blocked for **72 hours** (`409 tier_update_cooldown`).

**Auth:** Accepts API key or OAuth Bearer (`campaigns:write`).




## OpenAPI

````yaml /openapi/soundlink-public-api-v1.yaml patch /v1/campaigns/{campaignId}/tiers
openapi: 3.0.3
info:
  title: Soundlink Public API
  version: 0.0.1-draft
  description: >
    Campaign listing, metrics, and write operations for Soundlink partner
    organizations.


    **Base URL:** `https://api.getsoundlink.com`


    ## Authentication


    Send `Authorization: Bearer` with one of:


    1. **API key (recommended)** — a `sk_*` key from the Soundlink app
       (Settings → Developer → API keys):
       ```
       Authorization: Bearer sk_abc123_<token>
       ```

    2. **OAuth Bearer** — an access token from Sign in with Soundlink
       (authorization code or client credentials). Token scopes use the
       same strings as Public API key scopes (for example `campaigns:read`,
       `metrics:read`):
       ```
       Authorization: Bearer <oauth_access_token>
       ```

    `x-api-key` is no longer accepted and is ignored if sent. Requests

    without `Authorization: Bearer` return `401 invalid_api_key` (or

    `401 invalid_token` when a Bearer value is present but neither a

    recognized `sk_*` key nor a valid OAuth access token).


    ### Which operations accept OAuth?


    | Operations | Required scope | Auth |

    | --- | --- | --- |

    | `GET /v1/ping` | any granted Public API scope | API key (Bearer) or OAuth
    Bearer |

    | Campaign reads (`GET /v1/strategies`, `GET /v1/campaigns`, campaign
    detail, tiers) | `campaigns:read` | API key (Bearer) or OAuth Bearer |

    | Metrics reads (overview, breakdown, exports) | `metrics:read` | API key
    (Bearer) or OAuth Bearer |

    | Campaign writes (create, stop, budget, tier updates) | `campaigns:write` |
    API key (Bearer) or OAuth Bearer |

    | Video import / import status | `videos:write` | API key (Bearer) or OAuth
    Bearer |

    | Soundlink reads (list, detail, metrics overview/breakdown/engagement,
    JSONL exports) | `soundlinks:read` | API key (Bearer) or OAuth Bearer |

    | Soundlink writes (create, archive, test events) | `soundlinks:write` | API
    key (Bearer) or OAuth Bearer |

    | Wallet read (`GET /v1/wallet`) | `wallet:read` | API key (Bearer) or OAuth
    Bearer |


    Per-operation scope requirements are also marked with `x-required-scope`

    (except `GET /v1/ping`, which accepts any valid credential with at least

    one Public API scope granted to the key/token).


    All responses are wrapped in a standard envelope:

    ```json

    { "data": <payload>, "meta": { "requestId": "<uuid>" } }

    ```


    Errors follow the same envelope shape with an `error` field instead of
    `data`.
servers:
  - url: https://api.getsoundlink.com
    description: Production
security:
  - apiKeyBearerAuth: []
  - oauthBearer: []
tags:
  - name: System
    description: Connectivity and auth verification
  - name: Wallet
    description: Organization wallet balance
  - name: Campaigns
    description: >-
      Campaign listing, detail, creation, and wallet management (budget, stop,
      tiers)
  - name: Metrics
    description: Campaign performance metrics
  - name: Videos
    description: Partner video library import for Full Control campaigns
  - name: Soundlinks
    description: Soundlink listing, detail, creation, archive, and performance metrics
paths:
  /v1/campaigns/{campaignId}/tiers:
    patch:
      tags:
        - Campaigns
      summary: Update campaign tier allocation
      description: |
        Enable or disable geographic tiers and optionally reallocate budget
        shares for a wallet campaign.

        **Wallet campaigns only** (`generation: 3`).

        **Request rules:**
        - Include **all** tiers on the campaign in `items`
        - `newAllocationPercent` values must sum to **100**
        - At least one tier must have `isEnabled: true`

        **Cooldown:** after a successful update, further tier changes are
        blocked for **72 hours** (`409 tier_update_cooldown`).

        **Auth:** Accepts API key or OAuth Bearer (`campaigns:write`).
      operationId: updateCampaignTiers
      parameters:
        - $ref: '#/components/parameters/campaignId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCampaignTiersRequest'
            example:
              items:
                - targetingTierId: 1
                  isEnabled: true
                  newAllocationPercent: 70
                - targetingTierId: 2
                  isEnabled: true
                  newAllocationPercent: 30
      responses:
        '200':
          description: Updated tier allocation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignTiersResponse'
        '400':
          description: Invalid request or tier status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                invalid_request:
                  value:
                    error:
                      code: invalid_request
                      message: Tier updates are only supported for wallet campaigns.
                    meta:
                      requestId: 550e8400-e29b-41d4-a716-446655440000
                invalid_tier_status:
                  value:
                    error:
                      code: invalid_tier_status
                      message: At least one tier must be enabled
                    meta:
                      requestId: 550e8400-e29b-41d4-a716-446655440000
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/TierUpdateCooldown'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - apiKeyBearerAuth: []
        - oauthBearer: []
components:
  parameters:
    campaignId:
      name: campaignId
      in: path
      required: true
      schema:
        type: string
      description: Campaign identifier (UUID)
  schemas:
    UpdateCampaignTiersRequest:
      type: object
      required:
        - items
      properties:
        items:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/TierStatusUpdateItem'
    CampaignTiersResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          $ref: '#/components/schemas/CampaignTiersData'
        meta:
          $ref: '#/components/schemas/Meta'
    ErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          $ref: '#/components/schemas/Error'
        meta:
          $ref: '#/components/schemas/Meta'
    TierStatusUpdateItem:
      type: object
      required:
        - targetingTierId
        - isEnabled
        - newAllocationPercent
      properties:
        targetingTierId:
          type: integer
          minimum: 1
          description: Targeting tier identifier.
        isEnabled:
          type: boolean
          description: Whether to enable or disable this tier.
        newAllocationPercent:
          type: number
          minimum: 0
          maximum: 100
          description: New budget share for this tier (all items must sum to 100).
    CampaignTiersData:
      type: object
      required:
        - lastUpdate
        - tiers
      properties:
        lastUpdate:
          type: string
          format: date-time
          nullable: true
          description: |
            ISO-8601 timestamp of the last manual tier status update, or null
            if tiers have never been updated.
        tiers:
          type: array
          items:
            $ref: '#/components/schemas/CampaignTier'
    Meta:
      type: object
      required:
        - requestId
      properties:
        requestId:
          type: string
          format: uuid
          description: Server-generated request ID. Include when contacting support.
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable snake_case error code.
          enum:
            - invalid_api_key
            - api_key_revoked
            - api_key_expired
            - insufficient_scope
            - not_found
            - campaign_not_found
            - invalid_query_parameter
            - invalid_date_range
            - page_size_exceeded
            - invalid_request
            - invalid_genre
            - invalid_duration_or_budget
            - invalid_daily_budget
            - invalid_duration_days
            - invalid_spotify_url
            - invalid_tier_budget_allocation
            - invalid_tier_status
            - tier_update_cooldown
            - wallet_not_enabled
            - insufficient_credit
            - idempotency_key_conflict
            - rate_limit_exceeded
            - invalid_video_url
            - video_import_limit_exceeded
            - video_import_session_not_found
            - internal_error
        message:
          type: string
          description: Human-readable error description. Do not parse programmatically.
        details:
          type: object
          nullable: true
          description: |
            Additive, error-code-specific context (e.g. `available`/`required`
            on `insufficient_credit`). Absent or `null` for error codes that
            carry no extra data.
          additionalProperties: true
    CampaignTier:
      type: object
      required:
        - tierId
        - tierName
        - isEnabled
        - allocationPercent
      properties:
        tierId:
          type: integer
          description: Targeting tier identifier.
        tierName:
          type: string
          description: Human-readable tier name.
        isEnabled:
          type: boolean
          description: Whether this tier is currently active.
        allocationPercent:
          type: number
          minimum: 0
          maximum: 100
          description: Share of campaign budget allocated to this tier.
  responses:
    Unauthorized:
      description: |
        Missing or invalid credentials. Covers missing/malformed API keys,
        invalid or expired OAuth access tokens, and revoked API keys.
        `x-api-key` is not accepted and is ignored if sent.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Present only on `rate_limit_exceeded`
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalid_api_key:
              value:
                error:
                  code: invalid_api_key
                  message: 'Missing credentials. Send Authorization: Bearer.'
                meta:
                  requestId: 550e8400-e29b-41d4-a716-446655440000
            invalid_token:
              value:
                error:
                  code: invalid_token
                  message: OAuth access token is invalid or expired.
                meta:
                  requestId: 550e8400-e29b-41d4-a716-446655440000
            api_key_revoked:
              value:
                error:
                  code: api_key_revoked
                  message: >-
                    This API key has been revoked. Create a new key in Settings
                    → Developer → API keys.
                meta:
                  requestId: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: |
        Authenticated but not allowed: missing required scope, or OAuth access
        disabled for the organization (`access_denied`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficient_scope:
              value:
                error:
                  code: insufficient_scope
                  message: This token does not have the metrics:read scope.
                meta:
                  requestId: 550e8400-e29b-41d4-a716-446655440000
            access_denied:
              value:
                error:
                  code: access_denied
                  message: OAuth access is not enabled for this organization.
                meta:
                  requestId: 550e8400-e29b-41d4-a716-446655440000
    NotFound:
      description: Campaign not found or belongs to another organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: campaign_not_found
              message: Campaign not found.
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    TierUpdateCooldown:
      description: |
        Campaign tiers were updated in the last 72 hours. Wait for the cooldown
        to end before updating again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: tier_update_cooldown
              message: >-
                Campaign tiers were updated in the last 72 hours. Wait for the
                cooldown to end before updating again.
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    RateLimited:
      description: Per-key rate limit exceeded (60/min, 600/hr)
      headers:
        Retry-After:
          required: true
          schema:
            type: integer
          description: Seconds until the rate limit resets
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: rate_limit_exceeded
              message: >-
                Rate limit exceeded. Retry after the number of seconds indicated
                in the Retry-After header.
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
    InternalError:
      description: Unexpected server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: internal_error
              message: >-
                An unexpected error occurred. Contact support with the
                requestId.
            meta:
              requestId: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    apiKeyBearerAuth:
      type: http
      scheme: bearer
      description: |
        Pass your Soundlink `sk_*` API key as a Bearer token:
        `Authorization: Bearer sk_<prefix>_<token>` (not an OAuth token; see
        `oauthBearer` for that). Accepted on all Public API operations. Send
        only one `Authorization` header per request.
    oauthBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |
        OAuth 2.0 access token from Sign in with Soundlink
        (`Authorization: Bearer <oauth_access_token>`).
        Token scopes must include the operation's required scope
        (see `x-required-scope` and the Authentication section).
        Accepted on all Public API operations (reads and writes).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.