day3 API

openapi: 3.1.0
info:
  title: day3 API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 19 operation(s) read from 7 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; day3 has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 17
    pages-with-code: 2
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://day3.app/features/api
  - https://docs.day3.app/webhooks/endpoints
  - https://docs.day3.app/webhooks
  - https://docs.day3.app/quickstart
  - https://day3.app/features/automations
  - https://docs.day3.app/authentication
  - https://docs.day3.app/conventions
servers:
- url: https://go.day3.app
paths:
  /api/v1/audiences:
    get:
      operationId: get_api_v1_audiences
      tags:
      - Api
      summary: List audiences, returns a data array
      x-source: https://docs.day3.app/quickstart
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1AudiencesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_audiences
      tags:
      - Api
      summary: POST /api/v1/audiences
      x-source: https://docs.day3.app/quickstart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1AudiencesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://go.day3.app/api/v1/audiences  -H "Authorization: Bearer $DAY3_API_KEY " 200 with a data array: the key is live.
          401 invalid_api_key : mistyped or

          revoked. Send Every new organization gets a test address on a day3-owned domain, so your

          first send needs no DNS. Find it under Sending , on the card above the domain

          list. It looks like acme@sandbox.day3.app . curl -X POST https://go.day3.a'
  /api/v1/emails:
    post:
      operationId: post_api_v1_emails
      tags:
      - Api
      summary: Send an email via the API
      x-source: https://docs.day3.app/quickstart
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1EmailsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1EmailsResponse'
      x-evidence:
        kind: documentation
  /api/v1/webhooks:
    post:
      operationId: post_api_v1_webhooks
      tags:
      - Api
      summary: POST /api/v1/webhooks
      x-source: https://docs.day3.app/webhooks/endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1WebhooksRequest'
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1WebhooksResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST https://go.day3.app/api/v1/webhooks  -H \"Authorization: Bearer $DAY3_API_KEY \"  -H \"Content-Type: application/json\"\
          \  -d '{ \n \"url\": \"https://yourapp.com/webhooks/day3\", \n \"description\": \"production\", \n \"events\": [\"email.bounced\", \"\
          email.complained\", \"suppression.created\"] \n }' \n This response is the only time the API returns the signing secret. Capture\nit\
          \ now. \n { \n \" id \" : \"whe_2v0d"
  /audiences/aud_123/contacts:
    get:
      operationId: get_audiences_aud_123_contacts
      tags:
      - Audiences
      summary: Conventions
      x-source: https://docs.day3.app/conventions
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Param Values limit 1 to 100. Default 50.
      - name: after
        in: query
        required: false
        schema:
          type: string
        description: Opaque cursor. Pass the previous response’s next_cursor.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAudiencesAud123ContactsResponse'
      x-evidence:
        kind: documentation
  /automations/{id}/enroll:
    post:
      operationId: post_automations_id_enroll
      tags:
      - Automations
      summary: automations:enroll
      x-source: https://docs.day3.app/authentication
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /campaigns/{id}/schedule:
    post:
      operationId: post_campaigns_id_schedule
      tags:
      - Campaigns
      summary: Unlocks campaigns:send
      x-source: https://docs.day3.app/authentication
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /campaigns/{id}/send:
    post:
      operationId: post_campaigns_id_send
      tags:
      - Campaigns
      summary: Unlocks campaigns:send
      x-source: https://docs.day3.app/authentication
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /emails:
    post:
      operationId: post_emails
      tags:
      - Emails
      summary: Conventions
      x-source: https://docs.day3.app/conventions
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
        description: Your own string, 255 characters or fewer.
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /emails/{id}:
    get:
      operationId: get_emails_id
      tags:
      - Emails
      summary: Poll GET /emails/{id} to watch it reach delivered
      x-source: https://docs.day3.app/quickstart
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEmailsIdResponse'
      x-evidence:
        kind: documentation
  /v1/automations/{id}/enroll:
    post:
      operationId: post_v1_automations_id_enroll
      tags:
      - Automations
      summary: POST /v1/automations/{id}/enroll puts one address into a published automation, creating the contact if it's new.
      x-source: https://day3.app/features/api
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1AutomationsIdEnrollRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/emails:
    post:
      operationId: post_v1_emails
      tags:
      - Emails
      summary: POST /v1/emails takes from, to (up to 50 recipients), subject, and html or text, and returns an id you can poll for delivery status.
      x-source: https://day3.app/features/api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1EmailsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1EmailsResponse'
      x-evidence:
        kind: documentation
  /v1/webhooks:
    get:
      operationId: get_v1_webhooks
      tags:
      - Webhooks
      summary: List endpoints
      x-source: https://docs.day3.app/webhooks/endpoints
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WebhooksResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_webhooks
      tags:
      - Webhooks
      summary: Create an endpoint
      x-source: https://docs.day3.app/webhooks/endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1WebhooksRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1WebhooksResponse'
      x-evidence:
        kind: documentation
  /v1/webhooks/{webhookId}:
    delete:
      operationId: delete_v1_webhooks_webhookId
      tags:
      - Webhooks
      summary: Delete an endpoint
      x-source: https://docs.day3.app/webhooks/endpoints
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_v1_webhooks_webhookId
      tags:
      - Webhooks
      summary: Retrieve an endpoint
      x-source: https://docs.day3.app/webhooks/endpoints
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WebhooksWebhookidResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_v1_webhooks_webhookId
      tags:
      - Webhooks
      summary: Update an endpoint
      x-source: https://docs.day3.app/webhooks/endpoints
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchV1WebhooksWebhookidRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/webhooks/{webhookId}/deliveries:
    get:
      operationId: get_v1_webhooks_webhookId_deliveries
      tags:
      - Webhooks
      summary: Delivery log
      x-source: https://docs.day3.app/webhooks/endpoints
      parameters:
      - name: webhookId
        in: path
        required: true
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: cursor
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1WebhooksWebhookidDeliveriesResponse'
      x-evidence:
        kind: documentation
  /your/endpoint:
    post:
      operationId: post_your_endpoint
      tags:
      - Your
      summary: POST /your/endpoint receives webhook events from Day3.
      description: The webhook request is a JSON payload containing event details. The handler must verify the Day3‑Signature, parse the JSON,
        and return a 2xx response quickly.
      x-source: https://docs.day3.app/webhooks
      parameters:
      - name: Content-Type
        in: header
        required: true
        schema:
          type: string
        description: application/json
      - name: User-Agent
        in: header
        required: false
        schema:
          type: string
        description: Day3-Webhooks/1.0 (+https://day3.app)
      - name: Day3-Event-Id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier for the event, e.g., evt_2k4h9x4v0dz1
      - name: Day3-Event-Type
        in: header
        required: true
        schema:
          type: string
        description: Type of the event, e.g., email.bounced
      - name: Day3-Delivery-Attempt
        in: header
        required: true
        schema:
          type: integer
        description: Attempt count starting at 1
      - name: Day3-Signature
        in: header
        required: true
        schema:
          type: string
        description: HMAC‑SHA256 signature of the raw body
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostYourEndpointRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostYourEndpointResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiV1AudiencesResponse:
      type: object
      properties:
        data:
          type: array
          description: array of audience objects
    PostApiV1AudiencesRequest:
      type: object
      properties:
        from:
          type: string
        to:
          type: array
          items:
            type: string
        subject:
          type: string
        html:
          type: string
    PostApiV1EmailsRequest:
      type: object
      properties:
        from:
          type: string
        to:
          type: array
          description: array of strings
        subject:
          type: string
        html:
          type: string
      required:
      - from
      - to
      - subject
      - html
    PostApiV1EmailsResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        from:
          type: string
        to:
          type: array
          description: array of strings
        subject:
          type: string
        status:
          type: string
        sandbox:
          type: boolean
        created_at:
          type: string
          description: date‑time
        sent_at:
          type: string
          description: date‑time
        delivered_at:
          type: string
          description: date‑time
    PostApiV1WebhooksRequest:
      type: object
      properties:
        url:
          type: string
        description:
          type: string
        events:
          type: array
          items:
            type: string
    PostApiV1WebhooksResponse:
      type: object
      properties:
        ' id ':
          type: string
        ' object ':
          type: string
        ' url ':
          type: string
        ' secret ':
          type: string
        ' events ':
          type: array
          items:
            type: string
        ' status ':
          type: string
    GetAudiencesAud123ContactsResponse:
      type: object
      properties:
        data:
          type: array
          description: Array of contacts.
        has_more:
          type: boolean
          description: Indicates if more pages are available.
        next_cursor:
          type: string
          description: Cursor for the next page.
    GetEmailsIdResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        from:
          type: string
        to:
          type: array
          description: array of strings
        subject:
          type: string
        status:
          type: string
        sandbox:
          type: boolean
        created_at:
          type: string
          description: date‑time
        sent_at:
          type: string
          description: date‑time
        delivered_at:
          type: string
          description: date‑time
    PostV1AutomationsIdEnrollRequest:
      type: object
      properties:
        address:
          type: string
      required:
      - address
    PostV1EmailsRequest:
      type: object
      properties:
        from:
          type: string
        to:
          type: array
          description: up to 50 recipients
        subject:
          type: string
        html:
          type: string
        text:
          type: string
      required:
      - from
      - to
      - subject
    PostV1EmailsResponse:
      type: object
      properties:
        id:
          type: string
          description: id you can poll for delivery status
    GetV1WebhooksResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        url:
          type: string
        description:
          type: string
        events:
          type: array
        status:
          type: string
        consecutive_failures:
          type: integer
        last_success_at:
          type: string
        last_failure_at:
          type: string
        last_error:
          type: string
        created_at:
          type: string
    PostV1WebhooksRequest:
      type: object
      properties:
        url:
          type: string
        events:
          type: array
        description:
          type: string
      required:
      - url
      - events
    PostV1WebhooksResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        url:
          type: string
        secret:
          type: string
        events:
          type: array
        status:
          type: string
    GetV1WebhooksWebhookidResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        url:
          type: string
        description:
          type: string
        events:
          type: array
        status:
          type: string
        consecutive_failures:
          type: integer
        last_success_at:
          type: string
        last_failure_at:
          type: string
        last_error:
          type: string
        created_at:
          type: string
    PatchV1WebhooksWebhookidRequest:
      type: object
      properties:
        url:
          type: string
        description:
          type: string
        events:
          type: array
        status:
          type: string
    GetV1WebhooksWebhookidDeliveriesResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
        endpoint_id:
          type: string
        event_id:
          type: string
        event_type:
          type: string
        status:
          type: string
        attempt:
          type: integer
        response_status:
          type: integer
        error:
          type: string
        duration_ms:
          type: integer
        next_attempt_at:
          type: string
        delivered_at:
          type: string
        created_at:
          type: string
    PostYourEndpointRequest:
      type: object
      properties:
        id:
          type: string
          description: Event identifier, same as Day3-Event-Id
        type:
          type: string
          description: Event type, same as Day3-Event-Type
        created_at:
          type: string
          description: ISO‑8601 timestamp of event creation
        data:
          type: object
          description: Payload specific to the event type
      required:
      - id
      - type
      - created_at
      - data
    PostYourEndpointResponse:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code, e.g., 200 for success
        body:
          type: string
          description: Response body, e.g., "ok"
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api
- name: Audiences
- name: Automations
- name: Campaigns
- name: Emails
- name: Webhooks
- name: Your