API Changelog

We will post here any new changes and breaking changes in our APIs.

The field properties.labels was documented as an array of objects, but it should be used as a plain object. We apologize for any inconvenience this may have caused. Translations API:

• Document field properties.labels as a plain object.

Effectively from August 13th 2024 an undocumented field settings.capabilities was removed from the form definition. This is result of cleanup work to remove deprecated fields. We apologize for any inconvenience this may have caused given the lack of communication about this change. Create API:

• The field settings.capabilities was removed from the form definition.

Now it's possible to set enrichment setting via API for forms of accounts with access to the responses enrichment feature.

Create API:

• Ability to set enrichment setting within a form definition. See form settings for more details.

As a part of releasing partial responses we introduced new functionality to Create and Responses API.

Create API:

• Ability to create or update milestones within a form definition. See form settings for more details.

Responses API:

• Ability to fetch partial responses. See the new response_type query param for more details.

The webhook payload will now include the id and the ref of the selected choice in choice questions such as multiple-choice, picture-choice, dropdown or ranking.

This will help you identify which choice was selected regardless of its label, which is specially useful when you own many forms with different languages.

A typeform link follows the format https://domain.typeform.com/to/formId where formId is a unique string of random characters. Typeform links could be customized to remove this random string and be more explicit. Turning https://jonathan.typeform.com/to/zvlr4L into https://jonathan.typeform.com/contact.

When calling the Retrieve Form endpoint on a typeform that had a custom link, the API was returning the original link with form id. It now returns the custom link.

We decided to disable webhooks that respond with 404 status code.

We exposed a new PATCH endpoint on our themes API, for safely updating themes with partial payloads. Partial updates via the existing PUT endpoint are now deprecated.

We exposed two additional endpoints for downloading files uploaded by form respondents, both:

• on a per-file basis
• and for downloading the full set of respondent-uploaded files for a form.

New webhooks fields

We updated our webhooks structure to include the ending reference on both: a new field and the definition attribute. An example of a valid webhook payload can be found here.

Deprecating

We plan to gradually move default type from form to quiz. As such, we recommend developers implement this change by early December 2022. Valid value types can be found here.