DPF Contact API

openapi: 3.2.0
info:
  title: DPF Contact API
  version: 1.1.0
  description: '## Common error responses


    Unless otherwise noted, any authenticated endpoint may also return the following

    responses, each with the standard `ErrorResponse` body. To avoid repetition they are

    not listed individually on each operation:


    - **400 Bad Request** — malformed JSON, unknown action, or missing/invalid fields

    - **401 Unauthorized** — missing or invalid JWT bearer token

    - **402 Payment Required** — the account has insufficient credits or an inactive subscription

    - **403 Forbidden** — authenticated but not permitted (no access to the resource, or a higher access level / plan tier is required)


    Operation-specific responses (e.g. `404`, `409`) are documented on each endpoint.'
  contact:
    name: Contact DPF
    url: mailto:contact@dpf-it.com
  license:
    name: Proprietary
    url: https://dpf-it.com/#terms
servers:
- url: https://api.dpf-it.com
  description: Production API
security: []
tags:
- name: Contact
  description: 'Contact form endpoint with two modes: authenticated (user info auto-populated from account)

    and unauthenticated (email required in request body). No authentication required to submit.'
paths:
  /contact:
    post:
      tags:
      - Contact
      summary: Submit a contact form message
      description: 'Contact form endpoint that operates in two modes:


        ## Authenticated Mode (with JWT)


        When a valid `Authorization: Bearer ` header is provided, the user''s name and email

        are automatically retrieved from their account. The `email` and `name` fields in the request

        body are ignored — only `reason` and `message` are required.


        The contact email sent to the DPF team will include the user''s full name, email, and user ID.


        ## Unauthenticated Mode (pre-login)


        When no Authorization header is present, the `email` field is **required** in the request body

        so the team can respond. The `name` field is optional.


        ## Common Behavior


        - Messages are forwarded to the DPF team via email (contact@dpf-it.com)

        - Rate-limited by IP address

        - Reply-To is set to the sender''s email for easy follow-up'
      operationId: submitContactForm
      security:
      - BearerAuth: []
      - {}
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContactRequest'
            examples:
              authenticatedUser:
                summary: Authenticated user (no email/name needed)
                description: When logged in, only reason and message are required. User info is pulled from the account.
                value:
                  reason: request-a-feature
                  message: It would be great to have a bulk delete option for data specs.
              unauthenticatedDemo:
                summary: Unauthenticated - request a demo
                description: Pre-login users must provide an email address.
                value:
                  reason: request-a-demo
                  email: prospect@company.com
                  name: Jane Smith
                  message: We'd like to see a demo of the platform for our data team.
              unauthenticatedIssue:
                summary: Unauthenticated - report an issue
                value:
                  reason: report-an-issue
                  email: user@company.com
                  name: John Doe
                  message: Getting a 500 error when trying to start analysis on my data spec.
      responses:
        '200':
          description: Message sent successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Your message has been sent. We will get back to you shortly.
components:
  schemas:
    ContactRequest:
      type: object
      required:
      - reason
      - message
      properties:
        reason:
          type: string
          enum:
          - request-a-demo
          - understand-licensing
          - report-an-issue
          - request-a-feature
          description: Reason for contacting
          example: request-a-demo
        message:
          type: string
          description: Message body (max 5000 characters)
          example: We'd like to see a demo of the platform for our data team.
          maxLength: 5000
        email:
          type: string
          format: email
          description: 'Contact email address.

            **Required** when unauthenticated (no Authorization header).

            **Ignored** when authenticated — the user''s email is retrieved from their account.

            '
          example: user@company.com
        name:
          type: string
          description: 'Contact name.

            **Optional** when unauthenticated (used in the contact email if provided).

            **Ignored** when authenticated — the user''s name is retrieved from their account.

            '
          example: Jane Smith
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from login or registration