> ## 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.

# Send an onboarding message

> Send the creator a message about their onboarding, for example to ask them to link Instagram and send a proof. The creator gets it as onboarding feedback in the app, by push, and in Discord. Nothing else changes.

While a proof from the creator waits for review, the message is not sent and the request returns `409` with `code: proofs_waiting`. Approve or reject the proof instead; a rejection carries its own message to the creator.



## OpenAPI

````yaml /api-reference/openapi.json post /onboarding/{creatorId}/messages
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: **100 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:
  /onboarding/{creatorId}/messages:
    post:
      tags:
        - Onboarding
      summary: Send an onboarding message
      description: >-
        Send the creator a message about their onboarding, for example to ask
        them to link Instagram and send a proof. The creator gets it as
        onboarding feedback in the app, by push, and in Discord. Nothing else
        changes.


        While a proof from the creator waits for review, the message is not sent
        and the request returns `409` with `code: proofs_waiting`. Approve or
        reject the proof instead; a rejection carries its own message to the
        creator.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: path
          name: creatorId
          required: true
          schema:
            type: string
          description: Opaque creator id returned by `/creators`
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - programId
                - message
              properties:
                programId:
                  type: string
                  format: uuid
                message:
                  type: string
                  minLength: 1
                  maxLength: 1000
                  description: Shown to the creator. Say what to do next.
      responses:
        '200':
          description: Message sent
          content:
            application/json:
              schema:
                type: object
                required:
                  - programId
                  - creatorId
                  - sent
                properties:
                  programId:
                    type: string
                    format: uuid
                  creatorId:
                    type: string
                  sent:
                    type: boolean
                    enum:
                      - true
        '400':
          description: Invalid program, creator, or message
        '403':
          description: The program is read-only for this API key
        '404':
          description: Program not found, or the creator is not approved in the program
        '409':
          description: >-
            `code: proofs_waiting`: a proof waits for your decision; nothing was
            sent
        '502':
          description: >-
            The message reached no channel. The body includes a `code`; try
            again.
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.