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

# Trigger a quick send

> Create a room from a configured quick send option and schedule its invitations. The room is created asynchronously, so the response returns `202 Accepted` with a trigger id; poll GET /api/v1/quick-send/trigger/{id} to get the room id once it exists. The room owner configured on the option becomes the room creator and owner, and is notified by email. Authenticate using Bearer token with your Noux API key.



## OpenAPI

````yaml /openapi.json post /api/v1/quick-send/trigger
openapi: 3.0.0
info:
  title: Noux REST API
  version: 1.0.0
  description: >-
    OpenAPI specification for the Noux REST API. Human-readable reference:
    https://docs.nouxdigital.com/api/overview
  contact:
    name: Noux Digital Oy
    url: https://nouxdigital.com/
servers:
  - url: https://api.noux.app
    description: Production API
  - url: http://localhost:4000
    description: Local development
security: []
paths:
  /api/v1/quick-send/trigger:
    post:
      tags:
        - Quick send
      summary: Trigger a quick send
      description: >-
        Create a room from a configured quick send option and schedule its
        invitations. The room is created asynchronously, so the response returns
        `202 Accepted` with a trigger id; poll GET
        /api/v1/quick-send/trigger/{id} to get the room id once it exists. The
        room owner configured on the option becomes the room creator and owner,
        and is notified by email. Authenticate using Bearer token with your Noux
        API key.
      parameters:
        - schema:
            type: string
            description: Bearer token with Noux API key
          required: true
          description: Bearer token with Noux API key
          name: authorization
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                setId:
                  type: string
                  description: Quick send set id from GET /api/v1/quick-send/sets
                optionId:
                  type: string
                  description: Quick send option id belonging to the set
                invitees:
                  type: array
                  items:
                    type: object
                    properties:
                      email:
                        type: string
                        format: email
                      firstName:
                        type: string
                        maxLength: 100
                      lastName:
                        type: string
                        maxLength: 100
                    required:
                      - email
                  minItems: 1
                  maxItems: 20
                  description: People to invite. Each invitee gets a personalized link.
                customerName:
                  type: string
                  minLength: 1
                  maxLength: 200
                  description: >-
                    Customer name used in the room name and merge tags. Derived
                    from the invitee domain when omitted.
                schedule:
                  oneOf:
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - IMMEDIATELY
                      required:
                        - type
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - DELAY
                        businessDays:
                          type: integer
                          minimum: 0
                          maximum: 7
                        hours:
                          type: integer
                          minimum: 0
                          maximum: 23
                        minutes:
                          type: integer
                          minimum: 0
                          maximum: 60
                      required:
                        - type
                        - businessDays
                        - hours
                        - minutes
                    - type: object
                      properties:
                        type:
                          type: string
                          enum:
                            - TIME_OF_DAY
                        hour:
                          type: integer
                          minimum: 0
                          maximum: 23
                        minute:
                          type: integer
                          minimum: 0
                          maximum: 59
                        date:
                          type: string
                          pattern: ^\d{4}-\d{2}-\d{2}$
                      required:
                        - type
                        - hour
                        - minute
                        - date
                  description: >-
                    Send time chosen by the caller. Wall-clock times resolve in
                    `timeZone` and can be at most six months ahead.
                timeZone:
                  type: string
                  maxLength: 100
                  description: >-
                    IANA timezone used to resolve wall-clock send times, for
                    example "Europe/Helsinki". Defaults to UTC.
              required:
                - setId
                - optionId
                - invitees
      responses:
        '202':
          description: Quick send accepted and queued
          content:
            application/json:
              schema:
                type: object
                properties:
                  triggerId:
                    type: string
                    description: >-
                      Poll GET /api/v1/quick-send/trigger/{id} for the created
                      room id
                  scheduledSendAt:
                    type: string
                    description: ISO timestamp when the invitations will be sent
                required:
                  - triggerId
                  - scheduledSendAt
        '400':
          description: >-
            Bad request - invalid body, schedule not allowed for the set, or API
            surface not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    enum:
                      - true
                    description: Indicates this is an error response
                  code:
                    type: string
                    enum:
                      - PARSE_ERROR
                      - BAD_REQUEST
                      - INTERNAL_SERVER_ERROR
                      - NOT_IMPLEMENTED
                      - METHOD_NOT_SUPPORTED
                      - TIMEOUT
                      - CONFLICT
                      - PRECONDITION_FAILED
                      - PAYLOAD_TOO_LARGE
                      - UNPROCESSABLE_CONTENT
                      - TOO_MANY_REQUESTS
                      - CLIENT_CLOSED_REQUEST
                      - INVALID_INPUT
                      - UNAUTHORIZED
                      - NOT_FOUND
                      - FORBIDDEN
                      - INVALID_STATE
                      - SERVER_ERROR
                    description: Error code for programmatic handling
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - code
                  - message
        '401':
          description: Unauthorized - invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    enum:
                      - true
                    description: Indicates this is an error response
                  code:
                    type: string
                    enum:
                      - PARSE_ERROR
                      - BAD_REQUEST
                      - INTERNAL_SERVER_ERROR
                      - NOT_IMPLEMENTED
                      - METHOD_NOT_SUPPORTED
                      - TIMEOUT
                      - CONFLICT
                      - PRECONDITION_FAILED
                      - PAYLOAD_TOO_LARGE
                      - UNPROCESSABLE_CONTENT
                      - TOO_MANY_REQUESTS
                      - CLIENT_CLOSED_REQUEST
                      - INVALID_INPUT
                      - UNAUTHORIZED
                      - NOT_FOUND
                      - FORBIDDEN
                      - INVALID_STATE
                      - SERVER_ERROR
                    description: Error code for programmatic handling
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - code
                  - message
        '404':
          description: Quick send set or option not found for this organization
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: boolean
                    enum:
                      - true
                    description: Indicates this is an error response
                  code:
                    type: string
                    enum:
                      - PARSE_ERROR
                      - BAD_REQUEST
                      - INTERNAL_SERVER_ERROR
                      - NOT_IMPLEMENTED
                      - METHOD_NOT_SUPPORTED
                      - TIMEOUT
                      - CONFLICT
                      - PRECONDITION_FAILED
                      - PAYLOAD_TOO_LARGE
                      - UNPROCESSABLE_CONTENT
                      - TOO_MANY_REQUESTS
                      - CLIENT_CLOSED_REQUEST
                      - INVALID_INPUT
                      - UNAUTHORIZED
                      - NOT_FOUND
                      - FORBIDDEN
                      - INVALID_STATE
                      - SERVER_ERROR
                    description: Error code for programmatic handling
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - error
                  - code
                  - message
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Noux API key from your integration settings

````