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

# Create a List

> API to create / manage lists to send notification to a bulk list of users.



## OpenAPI

````yaml POST /v1/subscriber_list/
openapi: 3.1.1
info:
  title: SuprSend API
  description: APIs supported on suprsend platform
  version: 1.2.2
servers:
  - url: https://hub.suprsend.com
security:
  - sec0: []
  - BearerAuth: []
paths:
  /v1/subscriber_list/:
    post:
      summary: Create a List
      description: >-
        API to create / manage lists to send notification to a bulk list of
        users.
      operationId: create-list
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - list_id
              properties:
                list_id:
                  type: string
                  description: >-
                    Unique string identifier of the list. Add an id which
                    defines the type of users who are part of the list
                  default: _list_id_
                list_name:
                  type: string
                  description: >-
                    Name of the List. Add a name which defines the type of users
                    in the list
                  default: _list_name_
                list_description:
                  type: string
                  default: _some sample description_
      responses:
        '201':
          description: '201'
          content:
            application/json:
              examples:
                Result:
                  value:
                    list_id: product_updates
                    list_name: Product Update
                    list_description: Users subscribed to the newsletter
                    list_type: static_list
                    subscribers_count: 3
                    source: database_sync
                    is_readonly: false
                    status: active
                    track_user_entry: false
                    track_user_exit: false
                    requested_for_delete: false
                    created_at: '2024-02-21T19:10:01.906000Z'
                    updated_at: '2025-04-04T07:25:43.186475Z'
                    drafts: null
              schema:
                type: object
                properties:
                  list_id:
                    type: string
                    example: product_updates
                  list_name:
                    type: string
                    example: Product Update
                  list_description:
                    type: string
                    example: Users subscribed to the newsletter
                  list_type:
                    type: string
                    enum:
                      - static_list
                      - query_based
                  subscribers_count:
                    type: integer
                    description: number of users in the list
                  source:
                    type: string
                    description: source info on how the list is updated
                    example: database_sync
                  is_readonly:
                    type: boolean
                    example: false
                  status:
                    type: string
                    example: active
                  track_user_entry:
                    type: boolean
                    description: >-
                      Event `$USER_ENTERED_LIST - <list_id>` is generated when
                      user is added this list. Use this to trigger workflow on
                      user entry.
                  track_user_exit:
                    type: boolean
                    description: >-
                      Event `$USER_EXITED_LIST - <list_id>` is generated when
                      user is removed from this list. Use this to trigger
                      workflow on user exit.
                  requested_for_delete:
                    type: boolean
                    example: false
                  created_at:
                    type: string
                    format: date-time
                    example: '2024-02-21T19:10:01.906000Z'
                  updated_at:
                    type: string
                    format: date-time
                    example: '2025-04-04T07:25:43.186475Z'
                  drafts:
                    type: string
                    nullable: true
                    description: would show the draft list created to replace list users.
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value:
                    code: 400
                    error_code: error
                    type: ValidationError
                    message: '{"list_id": ["This field may not be blank."]}'
                    detail:
                      list_id:
                        - This field may not be blank.
              schema:
                type: object
                description: error code and related message detailing out the error
      deprecated: false
      security:
        - BearerAuth: []
components:
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where <token>
        is your auth token.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API_Key
      description: >-
        Pass as `Bearer <API_KEY>`. Get API Key from SuprSend dashboard
        Developers -> API Keys section.

````