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

# Add Creators to CRM List

> Adds one or more creator IDs to a CRM list. Use `userIds` for all adds. Single-creator adds may include contact metadata such as `contactEmail` and `proposedRate` when `userIds` contains exactly one creator.



## OpenAPI

````yaml POST /api/v2/crm/lists/{list_id}/creators
openapi: 3.1.0
info:
  title: CRM API
  description: >-
    Create CRM lists, add creators, check creator membership, and update CRM
    contacts. CRM API calls are free but require an active TopYappers
    subscription.
  version: 2.0.0
servers:
  - url: https://api.topyappers.com
security:
  - apiKeyAuth: []
paths:
  /api/v2/crm/lists/{list_id}/creators:
    post:
      tags:
        - CRM Creators
      summary: Add creators to a CRM list
      description: >-
        Adds one or more creator IDs to a CRM list. Use `userIds` for all adds.
        Single-creator adds may include contact metadata such as `contactEmail`
        and `proposedRate` when `userIds` contains exactly one creator.
      parameters:
        - $ref: '#/components/parameters/ListId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCrmCreatorsRequest'
            example:
              userIds:
                - instagram_57971538386
                - instagram_58848167468
              status: TO_OUTREACH
              notes: Imported from June search
      responses:
        '200':
          description: Creators processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddCrmCreatorsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/AuthError'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitError'
components:
  parameters:
    ListId:
      name: list_id
      in: path
      required: true
      description: CRM list ID.
      schema:
        type: string
  schemas:
    AddCrmCreatorsRequest:
      type: object
      additionalProperties: false
      properties:
        userIds:
          type: array
          minItems: 1
          maxItems: 500
          items:
            type:
              - string
              - integer
        status:
          $ref: '#/components/schemas/CrmStatus'
        notes:
          type: string
          nullable: true
        contactEmail:
          type: string
          nullable: true
          description: Allowed only when `userIds` contains one creator.
        instagramHandle:
          type: string
          nullable: true
          description: Allowed only when `userIds` contains one creator.
        tiktokHandle:
          type: string
          nullable: true
          description: Allowed only when `userIds` contains one creator.
        proposedRate:
          type: number
          nullable: true
          minimum: 0
          description: Allowed only when `userIds` contains one creator.
      required:
        - userIds
    AddCrmCreatorsResponse:
      type: object
      properties:
        message:
          type: string
          example: OK
        response:
          type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/CrmContact'
            requested_count:
              type: integer
            processed_count:
              type: integer
            added_count:
              type: integer
            created_count:
              type: integer
            reactivated_count:
              type: integer
            skipped_duplicate_count:
              type: integer
            skipped_invalid_count:
              type: integer
    CrmStatus:
      type: string
      enum:
        - TO_OUTREACH
        - OUTREACHED
        - NEGOTIATING
        - WORKING
        - DONE
        - CANCELLED
    CrmContact:
      type: object
      properties:
        id:
          type: string
        list_id:
          type: string
        user_id:
          type: string
        status:
          $ref: '#/components/schemas/CrmStatus'
        contact_email:
          type: string
          nullable: true
        handle:
          type: string
          nullable: true
        first_contact_date:
          type: string
          nullable: true
        last_contact_date:
          type: string
          nullable: true
        response_date:
          type: string
          nullable: true
        proposed_rate:
          type: number
          nullable: true
        agreed_rate:
          type: number
          nullable: true
        content_deliverables:
          type: string
          nullable: true
        notes:
          type: string
        active:
          type: boolean
        date_created:
          type: string
          nullable: true
        date_updated:
          type: string
          nullable: true
        influencer:
          type: object
          nullable: true
          additionalProperties: true
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
  responses:
    BadRequest:
      description: Invalid request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    AuthError:
      description: >-
        Missing or invalid API key, inactive subscription, or inaccessible team
        scope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: CRM list or contact not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    RateLimitError:
      description: Too many requests. The response includes a `Retry-After` header.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-ty-api-key

````