Headers

• X-PLANNR-ACCOUNT-UUID string

Path parameters

• form_uuid string Required

Responses

• 201 application/json
  Hide response attributes Show response attributes object

  • uuid string

    The UUID of the resource.

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • title string

    The title of the form

  • description string

    The description of the form

  • live boolean

    Whether the form is live

  • visibility string

    The visibility of the form

  • sections object

    The sections of the form. They include the forms questions in a array

    Hide sections attributes Show sections attributes object

    • uuid string
    • created_at string
    • updated_at string
    • section string
    • title string
    • help_text string
    • caption string
    • type string
    • required boolean
    • position integer
    • selection_options array[string]
    • target_field string
    • key string
    • linked_question string
    • linked_primary boolean
  • allowed_hosts array[string]

    Array of allowed domains that this form can be accessed from using different origins

  • draft_submissions_count integer

    Count of draft submissions against this form

  • submitted_submissions_count integer

    Count of submitted submissions against this form

  • create_client boolean

    Denotes if this form creates a new client when it is submitted from a public embed

  • client_type string

    If create_client is true, then the client_type is the type of client that will be created, possible values are client and prospect