Skip to main content
POST
Duplicate a form

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
integer
required

ID of the form to copy.

Response

object | null

Success

A form as the admin sees it. Responses also carry public_token, embed_settings, embed_url, and share_url, described under Generate a public token.

id

ID of the form.

countries
(object | null)[] | null

The countries the form is for. A post-purchase form is shown only for carts in one of them.

description

Description shown with the form.

form_components

The form's elements as the builder saved them, a JSON-encoded array of components. Each component carries the id of the active element it maps to, so you can send it back to Update a form to edit elements in place.

form_styles
object | null

The form's visual styles, or null when none are set.

form_redirect

URL the hosted form sends the respondent to after they submit, or null.

form_respondents_count

Number of respondents the form has, in any completion status.

form_type

post_purchase, general, or the retired pre_purchase; null when unset. See Update a form for what each type means.

status

draft or active. Only an active form is shown at checkout or served by its public token. Changing a form to active gives it a public token if it has none.

title

Title of the form.

updated_at

When the form last changed.