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

# Preview a creator step update

> Every change that follows from one intent, with the same checks and refusals as the update. Changes nothing.



## OpenAPI

````yaml /api-reference/openapi.json post /programs/{id}/creators/{creatorId}/step/preview
openapi: 3.0.4
info:
  title: Launchpoint Public API
  version: 1.0.0
  description: >-
    **Private preview.** The Launchpoint Public API is in private preview and
    available only to trusted partners we work with directly. Access is not
    self-serve. Email hi@launchpointhq.com to ask about access.


    REST API for Launchpoint brands and agencies. Use an API key in the
    `x-api-key` header to authenticate.


    ## Requirements

    - Public API access must be enabled for the company. During private preview,
    access is limited to trusted partners.

    - Create and manage API keys in Dashboard → Settings → Developer.


    ## Creator privacy

    - Responses never include creator email addresses. Creator phone numbers are
    null when no number is stored or the workspace does not have access to
    creator contact details.


    ## Rate limits

    - Default: **200 requests per minute** per API key.

    - Approved partner accounts: **400 requests per minute**.

    - Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
    `X-RateLimit-Reset`. Requests over the limit return `429`.


    ## Errors

    - Errors use `{ "error": "<message>" }` with the matching HTTP status. Some
    endpoints also include a `code`.


    ## Timestamps

    - Timestamps are Unix timestamps in milliseconds unless a field says
    otherwise.


    ## Pagination

    - Most list endpoints accept `page` and `limit` and return `{ data, page,
    total }`. Some also return `totalPages`.

    - `scope=company` is the default. A parent agency key can pass
    `scope=agency` on supported routes to include its own data and linked
    brands.
servers:
  - url: https://dashboard.launchpointhq.com/api/v1
    description: Live API server
security:
  - apiKeyAuth: []
tags:
  - name: Deals
    description: Public creator opportunities across Launchpoint
  - name: Programs
    description: Programs and campaign management
  - name: Posts
    description: Posts and social content
  - name: Analytics
    description: KPIs and performance metrics
  - name: Payouts
    description: Payouts, balances, and pending creator funds
  - name: Contracts
    description: Contracts and creator agreements
  - name: Creators
    description: Creator profiles and metrics
  - name: Applications
    description: Creator applications to Canvas programs
  - name: Messages
    description: Read and send creator messages
  - name: Onboarding
    description: 'Creator onboarding: status, messages, and proof review'
  - name: Media review
    description: >-
      Review the media creators send before they post: queue, status, approve,
      and reject
paths:
  /programs/{id}/creators/{creatorId}/step/preview:
    post:
      tags:
        - Programs
      summary: Preview a creator step update
      description: >-
        Every change that follows from one intent, with the same checks and
        refusals as the update. Changes nothing.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: path
          name: id
          required: true
          schema:
            type: string
          description: ID of the program
        - in: path
          name: creatorId
          required: true
          schema:
            type: string
          description: Creator id from `GET /creators`
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - intent
              properties:
                intent:
                  type: object
                  description: >-
                    What you pick. A step moves the creator there with its pay,
                    Discord, trial, and round-robin coach. A payscale changes
                    the pay, and moves the creator to the one step with that pay
                    when exactly one step has it. A coach changes only the
                    coach.
                  oneOf:
                    - type: object
                      required:
                        - kind
                        - stepId
                      properties:
                        kind:
                          type: string
                          enum:
                            - step
                        stepId:
                          type: string
                          description: A step id from `GET .../step`.
                    - type: object
                      required:
                        - kind
                        - payscaleId
                      properties:
                        kind:
                          type: string
                          enum:
                            - pay
                        payscaleId:
                          type: string
                          nullable: true
                          description: >-
                            A payscale id from `GET
                            /programs/{id}/pay-structures`, or `null` for
                            Default.
                    - type: object
                      required:
                        - kind
                        - coachId
                      properties:
                        kind:
                          type: string
                          enum:
                            - coach
                        coachId:
                          type: string
                          nullable: true
                          description: >-
                            A coach's creator id from `GET /creators`, or `null`
                            for no coach.
                applyToPastVideos:
                  type: boolean
                  default: false
                  description: >-
                    Also count the creator's submitted, unpaid videos that a
                    re-price at the new pay would change.
                trialEndsAt:
                  type: string
                  format: date-time
                  description: >-
                    When the change starts a trial: the moment the trial ends.
                    ISO-8601 with `Z` or a UTC offset, for example
                    `2026-12-05T23:59:59-05:00`. It must be in the future and at
                    most 366 days ahead. The trial then ends at this moment, not
                    on the program's day or video limit. Leave it out to keep
                    the program's limit.
      responses:
        '200':
          description: The proposed changes
          content:
            application/json:
              schema:
                type: object
                properties:
                  programId:
                    type: string
                  creatorId:
                    type: string
                  version:
                    type: integer
                    description: Send it with the update.
                  changes:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          enum:
                            - step
                            - pay
                            - trial
                            - discord
                            - coach
                            - contract
                            - notice
                        before:
                          type: string
                          nullable: true
                        after:
                          type: string
                          nullable: true
                        required:
                          type: boolean
                          description: The intent's own change. It cannot be skipped.
                  startsTrial:
                    type: boolean
                    description: >-
                      The change starts a trial, so the update can take
                      `trialEndsAt`.
                  pastVideos:
                    type: object
                    nullable: true
                    description: >-
                      With `applyToPastVideos`: the submitted videos a re-price
                      would change.
                    properties:
                      total:
                        type: integer
                      willChange:
                        type: integer
        '400':
          description: >-
            The request is invalid, or a refusal: a payscale or coach not on the
            program, a skip of the intent's own change,
            `trial_end_not_applicable` (`trialEndsAt` on a change that starts no
            trial, or that skips `trial`), or `invalid_trial_end` (`trialEndsAt`
            not in the future, or more than 366 days ahead). The body has
            `error` and, for the trial end refusals, `code`.
        '403':
          description: This key cannot change the program
        '404':
          description: No program, step, or approved creator was found
components:
  parameters:
    ScopeParam:
      in: query
      name: scope
      required: false
      schema:
        type: string
        enum:
          - company
          - agency
        default: company
      description: >-
        Choose the data scope. `company` (default) limits results to the API key
        company's data. `agency` includes the parent agency and its linked
        brands. `scope=agency` requires a parent agency key; other keys receive
        `403`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created in Dashboard → Settings → Developer

````

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