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

# Capture a signup

> Record a signup: consent for a delivery handle, plus the fields the form
collected.

Whether consent settles immediately or waits for a double opt-in
confirmation is the channel's configuration, so one call covers both and
the response says which happened.



## OpenAPI

````yaml https://api.hightouch.io/api/swagger.json post /signups
openapi: 3.0.0
info:
  title: Hightouch API
  version: 1.0.0
  description: Hightouch Public Rest API to access syncs, models, sources and destinations
  contact:
    name: Hightouch
    url: https://hightouch.com
servers:
  - url: https://api.hightouch.com/api/v1
security: []
paths:
  /signups:
    post:
      summary: Capture a signup
      description: |-
        Record a signup: consent for a delivery handle, plus the fields the form
        collected.

        Whether consent settles immediately or waits for a double opt-in
        confirmation is the channel's configuration, so one call covers both and
        the response says which happened.
      operationId: CreateSignup
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSignupRequest'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/CreateSignupResponse'
                  - $ref: '#/components/schemas/SignupErrorResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupErrorResponse'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupErrorResponse'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupErrorResponse'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/SignupErrorResponse'
                  - $ref: '#/components/schemas/ValidateErrorJSON'
        '500':
          description: Something went wrong
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '502':
          description: Confirmation could not be sent
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignupErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    CreateSignupRequest:
      properties:
        traits:
          $ref: '#/components/schemas/SignupTraitsRequest'
        optIn:
          type: string
          enum:
            - single
            - double
          description: >-
            Force an opt-in style. Omit to let the topic and channel decide; a
            value

            they cannot honor is refused rather than silently resolved.
        source:
          type: string
          description: Which form or landing page this signup came from.
        topicExternalIdentifier:
          type: string
        topicId:
          type: string
          description: >-
            The subscription topic being consented to, by id or external
            identifier.

            Omit both to record consent for the channel itself.
        channel:
          $ref: '#/components/schemas/SignupChannel'
        handle:
          type: string
          description: Email address or E.164 phone number, matching `channel`.
      required:
        - channel
        - handle
      type: object
    CreateSignupResponse:
      properties:
        status:
          type: string
          enum:
            - subscribed
            - doi_pending_confirmation
      required:
        - status
      type: object
      description: >-
        `subscribed` means consent settled in this request.
        `doi_pending_confirmation`

        means a confirmation was sent and consent settles when the person
        answers,

        which may be days later.
    SignupErrorResponse:
      properties:
        message:
          type: string
        code:
          type: string
      required:
        - message
        - code
      type: object
    ValidateErrorJSON:
      properties:
        message:
          type: string
          enum:
            - Validation failed
          nullable: false
        details:
          properties: {}
          additionalProperties: {}
          type: object
      required:
        - message
        - details
      type: object
      additionalProperties: false
    InternalServerError:
      type: string
      enum:
        - Internal Server Error
      nullable: false
    SignupTraitsRequest:
      properties: {}
      additionalProperties:
        anyOf:
          - type: string
          - type: number
            format: double
          - type: boolean
        nullable: true
      type: object
      description: |-
        A signup's own fields, as collected by the form. They are written to the
        customer's warehouse and never stored by Hightouch.
    SignupChannel:
      type: string
      enum:
        - email
        - sms
      description: Delivery channels a signup can consent on.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Bearer

````