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

# Create a submission

> Creates a new form submission for a contact.

Create a submission

**Permission:** Requires `manage_forms` **or** `create_form_submissions`. Denials read `create_form_submissions`.



## OpenAPI

````yaml /api-reference/specs/forms.json post /api/form/submissions
openapi: 3.1.0
info:
  title: ConveYour API — Forms
  description: Retrieve form definitions and manage form submissions.
  version: 1.0.0
servers:
  - url: https://{subdomain}.conveyour.com
    description: Your organization's ConveYour instance
    variables:
      subdomain:
        default: acme
        description: >-
          Your organization's slug — the subdomain you sign in on. Replace
          `acme` with yours: if you sign in at `bigco.conveyour.com`, enter
          `bigco`.
security:
  - conveyourToken: []
tags:
  - name: Forms
    description: Retrieve form definitions and manage form submissions.
paths:
  /api/form/submissions:
    post:
      tags:
        - Forms
      summary: Create a submission
      description: >-
        Creates a new form submission for a contact.


        Create a submission


        **Permission:** Requires `manage_forms` **or**
        `create_form_submissions`. Denials read `create_form_submissions`.
      operationId: createASubmission
      parameters:
        - $ref: '#/components/parameters/teams'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - obj_id
                - contact_id
              properties:
                obj_id:
                  description: The submission collection (form definition) ID.
                  type: string
                contact_id:
                  description: The contact this submission belongs to.
                  type: string
                status:
                  description: Initial submission status. Defaults to `"pending"`.
                  type: string
                data:
                  description: Key/value pairs of submitted field data.
                  type: object
                  additionalProperties: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Envelope'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/FormSubmission'
              example:
                status: ok
                message: Submission created
                data:
                  id: 64a1b2c3d4e5f6a7b8c9d0e1
                  obj_id: COLLECTION_ID
                  contact_id: CONTACT_ID
                  status: pending
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          description: >-
            Too many requests — plan quota exhausted. Applies to **POST only**.
            `data` carries the usage overview for the `form_submissions` limit
            (used / unused / overage) so you can show what was hit.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - failed
                    description: Always `failed`.
                  message:
                    type: string
                    description: Human-readable explanation.
                  data:
                    type: object
                    description: >-
                      Usage overview for the limit that was hit — used, unused
                      and overage counts.
components:
  parameters:
    teams:
      name: teams[]
      in: query
      description: >-
        Team scope for the request, as one or more team ObjectIds. The brackets
        are required: PHP keeps only the last value for a repeated plain key, so
        `teams=A&teams=B` silently resolves to B alone. On requests with a JSON
        body you may send `teams` (no brackets) in the body instead.


        **Values that are not valid ObjectIds are silently ignored** — a
        mistyped team ID behaves as if no team was sent. See the [teams section
        of the API conventions guide](/guides/api-conventions#team-scoping).
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
      example:
        - 64a1b2c3d4e5f6a7b8c9d0ff
  schemas:
    Envelope:
      type: object
      description: The common response envelope shared by all ConveYour endpoints.
      properties:
        status:
          type: string
          enum:
            - ok
            - failed
          description: '`ok` on success, `failed` on error.'
        message:
          type: string
          description: Human-readable description of the result.
        data:
          description: >-
            The response payload — an object or an array depending on the
            endpoint.
    FormSubmission:
      type: object
      description: >-
        A form submission. Fields come from the parent submission collection's
        org-defined schema, so the field set varies per organization.
      properties:
        id:
          type: string
          description: Submission ID.
        obj_id:
          type: string
          description: >-
            Parent submission collection. Required — the submission is rejected
            without it.
        org_id:
          type: integer
          description: Owning organization.
        con_id:
          type: array
          description: Contacts the submission belongs to.
        status:
          type: string
          description: Submission status.
        due:
          type: string
          description: Due date.
        sections:
          type: array
          description: Section definitions carried from the collection.
        created_at:
          type: integer
          description: Unix timestamp.
        updated_at:
          type: integer
          description: Unix timestamp.
      required:
        - obj_id
      additionalProperties:
        description: Any field defined on the parent submission collection's schema.
  responses:
    Forbidden:
      description: >-
        The token is missing or invalid, or the service account behind it lacks
        the permission this endpoint requires.
      content:
        application/json:
          example:
            status: failed
            message: Lacking necessary permission add_contacts
            data:
              permission: add_contacts
  securitySchemes:
    conveyourToken:
      type: apiKey
      in: header
      name: x-conveyour-token
      description: >-
        Your API key token. Contacts endpoints require a **Server-only — Full
        API** key — see [Authentication](/quickstart).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.