100Hires Notification Messages API

openapi: 3.2.0
info:
  title: 100Hires Notification Messages API
  version: 2.0.0
  description: '## Introduction to the 100Hires ATS API

    The 100Hires ATS API (v2) helps you automate recruiting workflows end-to-end: candidates, applications, jobs, forms, notes, and partner-company operations. All endpoints return JSON and use bearer authentication. ## OpenAPI Spec

    The 100Hires ATS API follows the OpenAPI 3.x specification. Download the machine-readable spec for use in MCP servers, Cursor, Claude Code, or any OpenAPI tooling:


    `GET https://api.100hires.com/v2/openapi.json`


    ## Authentication

    Send API token in the `Authorization` header for every request:


    `Authorization: Bearer `


    Each API key is tied to a specific **user + company** pair. If the same user belongs to multiple companies, they need a separate key for each company. All actions performed through the API are attributed to the key owner. You can generate or view your API key at https://app.100hires.com/settings/integrations


    ### API Key Verification

    API keys for **unverified companies** are created in a disabled state and will return `401 Unauthorized` until the company passes verification. Once your company is verified, API keys start working automatically — no action required. If your key returns `401` and you believe your company should be verified, contact **support@100hires.com**. ## Rate Limits

    API keys that are not yet approved, such as keys created during the free trial, are subject to a hard rate limit of **1,000 requests per 10 minutes** per company. All API keys and MCP connections of a company share this limit. If your company is managed by a partner, it shares the partner''s limit. Personal API keys are approved automatically when the company starts a paid subscription. Requests over the limit receive a `429 Too Many Requests` response. ### Rate limit headers

    Unapproved keys include these headers on every response:


    | Header | Description |

    |--------|-------------|

    | `X-RateLimit-Limit` | Maximum requests allowed in the current window |

    | `X-RateLimit-Remaining` | Requests remaining in the current window |

    | `X-RateLimit-Reset` | Unix timestamp (seconds) when the window resets |


    ### Handling 429 responses

    When you receive a `429` response, wait until `X-RateLimit-Reset` before retrying. Do not retry immediately — repeated 429s may extend the cooldown. To remove rate limits for your integration, contact **support@100hires.com** with your use case. ## Content-Type

    All request bodies **must** use `Content-Type: application/json`. Sending `application/x-www-form-urlencoded`, `multipart/form-data`, or any other content type

    will result in a `415 Unsupported Media Type` error. ## Responses and Errors

    Standard HTTP status codes are used (`2xx`, `4xx`, `5xx`). All error responses are wrapped in an `error` object containing `name`, `message`, `code`, and `status`. Validation errors additionally include field-level details in `error.validation_errors`. See the Error handling section below for the full format and status table. ## Pagination

    List endpoints use `page` (1-based) and `size` (1-100, default 20). Paginated responses follow:

    `{ "": [...], "pagination": { "page_size", "page_count", "page", "total_count" } }`. ## Lists

    List routes are optimized for synchronization and operational dashboards. Most list endpoints support tenant scoping through optional `company_id` (when allowed by API key context). ## Confidential Data

    Some candidate profile values can be masked by account-level pricing/access rules. Integrations should not assume all profile fields are always fully visible. ## Customizing the Response

    Use endpoint filters (`status`, `job_id`, timestamps, taxonomy IDs, etc.) to minimize payload size and improve sync efficiency. Build incremental sync flows around timestamp filters where available. ## Supported File Formats

    File uploads use base64 payloads with metadata:

    `data`, `file_name`, `mime_type` (and optionally `size`). This format is used for candidate files, resumes, attachments, and logos.'
servers:
- url: https://api.100hires.com/v2
  description: Production API endpoint
security:
- BearerAuth: []
tags:
- name: Notification Messages
  description: 'Manage notification emails (rejection, interview reminders, etc.) auto-created by the system: view, edit, cancel, or bulk-cancel before delivery.'
paths:
  /notification-messages/{id}:
    get:
      tags:
      - Notification Messages
      summary: Get notification message
      operationId: getNotificationMessage
      parameters:
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          description: Notification message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationMessage'
              example:
                id: 70001
                from: notifications@example.com
                to: john.doe@example.com
                subject: Update on your application
                body: <p>Thank you for applying. Unfortunately we have decided to move forward with other candidates.</p>
                date: Mar 22, 2024 09:00 AM
                schedule:
                  id: 8801
                  isScheduled: true
                  isFailed: false
                  humanDatetime: Mar 22, 2024 09:00 AM
                  isNotificationMessage: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Returns a notification email message (e.g. rejection email) by its ID, including subject, body, sender, recipient, and schedule metadata.
    put:
      tags:
      - Notification Messages
      summary: Update notification message
      operationId: updateNotificationMessage
      parameters:
      - $ref: '#/components/parameters/IdPath'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationMessageUpdateRequest'
      responses:
        '200':
          description: Updated notification message
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationMessage'
              example:
                id: 70001
                from: notifications@example.com
                to: john.doe@example.com
                subject: Update on your application (revised)
                body: <p>Thank you for your interest. We'd like to keep your profile on file for future roles.</p>
                date: Mar 22, 2024 09:00 AM
                schedule:
                  id: 8801
                  isScheduled: true
                  isFailed: false
                  humanDatetime: Mar 24, 2024 09:00 AM
                  isNotificationMessage: true
        '415':
          $ref: '#/components/responses/UnsupportedMediaType'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '400':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Updates subject, body, and optionally reschedules a notification email before it is sent. Only scheduled (not yet sent) messages can be updated.
    delete:
      tags:
      - Notification Messages
      summary: Cancel notification message
      operationId: cancelNotificationMessage
      parameters:
      - $ref: '#/components/parameters/IdPath'
      responses:
        '200':
          description: Message canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
              example:
                success: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '400':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Cancels a scheduled notification email before it is sent. Already sent messages cannot be canceled.
  /candidates/{id}/notification-messages:
    delete:
      tags:
      - Notification Messages
      summary: Cancel all notification messages for candidate
      operationId: cancelAllNotificationMessages
      parameters:
      - $ref: '#/components/parameters/CandidateIdPath'
      responses:
        '200':
          description: All scheduled notifications canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
              example:
                success: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      description: Cancels all scheduled notification emails for a candidate. Already sent notifications are not affected. Returns success even if no scheduled notifications exist.
components:
  responses:
    NotFound:
      description: Not found
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Not Found
              message: Candidate not found
              code: 0
              status: 404
    TooManyRequests:
      description: Too many requests
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Too Many Requests
              message: Rate limit exceeded
              code: 0
              status: 429
    UnsupportedMediaType:
      description: Content-Type must be application/json
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Unsupported Media Type
              message: Content-Type must be application/json
              code: 0
              status: 415
    Forbidden:
      description: Forbidden
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Forbidden
              message: You are not allowed to perform this action.
              code: 0
              status: 403
    ValidationError:
      description: Validation error
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationError'
    Unauthorized:
      description: Unauthorized
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              name: Unauthorized
              message: Your request was made with invalid credentials.
              code: 0
              status: 401
  schemas:
    NotificationMessageUpdateRequest:
      type: object
      required:
      - subject
      - body
      properties:
        subject:
          type: string
          maxLength: 500
          description: Email subject line.
        body:
          type: string
          description: Email body as HTML.
        scheduled_at:
          type: integer
          format: int64
          nullable: true
          description: Unix timestamp (seconds) to reschedule send time. If omitted, the existing schedule is preserved.
      additionalProperties: false
    NotificationMessageSchedule:
      type: object
      required:
      - id
      - isScheduled
      - isFailed
      - humanDatetime
      - isNotificationMessage
      properties:
        id:
          type: integer
          description: Schedule ID.
        isScheduled:
          type: boolean
          description: Whether currently scheduled.
        isFailed:
          type: boolean
          description: Whether send failed.
        humanDatetime:
          type: string
          description: Human-readable scheduled time.
        isNotificationMessage:
          type: boolean
          description: Always true for notification messages.
      additionalProperties: false
    ValidationError:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          description: Validation error details object.
          required:
          - name
          - validation_errors
          properties:
            name:
              type: string
              description: Always "Validation Error" for validation failures
              example: Validation Error
            message:
              type: string
            code:
              type: integer
              example: 0
            status:
              type: integer
              example: 400
            validation_errors:
              type: object
              description: Field-level validation errors (field name to error message)
              additionalProperties:
                type: string
              example:
                email: Email cannot be blank.
                first_name: First Name cannot be blank.
      example:
        error:
          name: Validation Error
          message: ''
          code: 0
          status: 400
          validation_errors:
            email: Email cannot be blank.
            first_name: First Name cannot be blank.
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          description: Error details object.
          required:
          - name
          - message
          - code
          - status
          properties:
            name:
              type: string
              description: Human-readable error type (e.g. "Not Found", "Bad Request", "Forbidden")
              example: Not Found
            message:
              type: string
              description: Detailed error message
              example: Candidate not found
            code:
              type: integer
              description: Application error code (0 for generic errors)
              example: 0
            status:
              type: integer
              description: HTTP status code
              example: 404
      example:
        error:
          name: Not Found
          message: Candidate not found
          code: 0
          status: 404
    NotificationMessage:
      type: object
      required:
      - id
      - from
      - to
      - subject
      - body
      - date
      - schedule
      properties:
        id:
          type: integer
          description: Message ID.
        from:
          type: string
          description: Sender address.
        to:
          type: string
          description: Recipient address.
        subject:
          type: string
          description: Message subject.
        body:
          type: string
          description: Message body as HTML that is safe to render. The markup of the email is kept after sanitizing.
        date:
          type: string
          description: Message date.
        schedule:
          oneOf:
          - type: string
            enum:
            - ''
          - $ref: '#/components/schemas/NotificationMessageSchedule'
      additionalProperties: false
    SuccessResponse:
      type: object
      required:
      - success
      properties:
        success:
          type: boolean
          description: Always true on success.
  headers:
    RateLimitRemaining:
      description: Remaining requests in the current rate-limit window. Returned for unapproved API keys.
      schema:
        type: integer
    RateLimitReset:
      description: Unix timestamp when the current rate-limit window resets. Returned for unapproved API keys.
      schema:
        type: integer
        format: int64
    RateLimitLimit:
      description: Request limit for the current rate-limit window. Returned for unapproved API keys.
      schema:
        type: integer
  parameters:
    CandidateIdPath:
      name: id
      in: path
      required: true
      schema:
        type: string
        pattern: ^[A-Za-z0-9_-]+$
      description: Candidate ID (numeric) or alias
    IdPath:
      name: id
      in: path
      required: true
      description: Resource ID (numeric).
      schema:
        type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: APIKey
      description: 'Provide API token in header: `Authorization: Bearer <token>`. Each key is scoped to a specific user + company pair.'
    CompanySlugAuth:
      type: apiKey
      in: header
      name: X-Company-Slug
      description: 'Company slug for career site public endpoints. Alternative: pass as query param `company_slug`.'
x-tagGroups:
- name: Recruiting Operations
  tags:
  - Candidates
  - Applications
  - Interviews
  - Jobs
  - Evaluations
  - Notes
  - Messages
  - Notification Messages
  - Forms
  - Questions
  - Email Templates
  - Nurture Campaigns
  - Template Placeholders
  - Users
  - Attachments
- name: Organization and Settings
  tags:
  - Companies
  - Taxonomy
  - Billing
  - Feedback
- name: Career Site (Public)
  tags:
  - Career Site