Configuring Partial Submit Points via API – Is It Supported? | Community
Skip to main content
Question

Configuring Partial Submit Points via API – Is It Supported?

P

Hello Typeform Community,

I’m trying to automate adding Partial Submit Points using the Typeform API, but I can’t find any reference to the necessary fields or endpoints in the published docs.

According to the “Collect partial responses” article, it should be possible to configure a Partial Submit Point in a form via the API and access partial responses via the API. However, when I inspect the Create Form and Update Form endpoints in the Developer Portal, there’s no mention of a partial_submit_point property or any equivalent parameter Typeform.

Here’s what I’ve tried so far:

  1. Create a new form via POST https://api.typeform.com/forms with a body similar to the one for adding a Partial Submit Point in the web builder, but nothing happens.

  2. Update an existing form via PATCH https://api.typeform.com/forms/{form_id}, attempting to include a Partial Submit Point object, but the request is  returns a validation error.

  3. Inspect the API schema for “fields,” “logic,” and other sections—nowhere is the Partial Submit Point documented.

Has anyone successfully added or moved a Partial Submit Point programmatically via the API?

  • Which endpoint and payload did you use?

  • Is there an undocumented field I’m missing?

  • Or is this feature not yet fully available via the API?

Any guidance, example payloads, or workarounds would be greatly appreciated. Thank you in advance! 🙏

    2 replies

    Liz
    Community Team
    Forum|alt.badge.img+5
    • Liz
    • Tech Community Advocate
    • 15035 replies
    • May 1, 2025

    ​@picsoung do you happen to know if this is possible? I don’t believe so, but I could be wrong!

    Life is a series of awkward moments separated by snacks.
    P
    1 person likes this
    • P
      poshsnyam
    picsoung
    Typeform
    Forum|alt.badge.img+5
    • picsoung
    • Developer Advocate @ Typeform
    • 392 replies
    • May 27, 2025

    Hi ​@poshsnyam 

    I am sorry I have missed your question before.

    whenever it comes to API, my general advice, is to make the thing manually in the form and then inspect the JSON by calling https://api.typeform.com/forms/{form_id}

    We should definitively highlight partial submissions more in the documentation.

    Basically it adds a milestones array in the settings

    for example:
     

    "settings": {
    "language": "en",
    "progress_bar": "proportion",
    "meta": {
      "allow_indexing": false
    },
    "hide_navigation": false,
    "is_public": true,
    "is_trial": false,
    "show_progress_bar": true,
    "show_typeform_branding": true,
    "are_uploads_public": false,
    "show_time_to_complete": true,
    "show_number_of_submissions": false,
    "show_cookie_consent": false,
    "show_question_number": true,
    "show_key_hint_on_choices": true,
    "autosave_progress": true,
    "free_form_navigation": false,
    "use_lead_qualification": false,
    "pro_subdomain_enabled": false,
    "milestones": [
      {
        "field_ref": "01HRSAHWW5ZZHSCTT4JBC04NAF",
        "status": "active"
      }
    ],
    "auto_translate": true,
    "partial_responses_to_all_integrations": false
  },

     Each milestone is an object with the corresponding field_ref for field reference 
    You can find each field’s reference in the fields array.

    Hope this makes sense
    Can’t wait to see what you build

    Cheers

    john.desborough
    Grace
    2 people like this
    • john.desborough
      john.desborough
    • Grace
      Grace

    Reply


    Still need help?

    Don't be shy and ask the community.

    Ask your question here!
    Community T&Cs