Public Endpoints

Get a public form by id

get
Query parameters
langstring · enumOptional

Language used to generate review responses

Possible values:
idstring · uuidRequired

Contact form ID to retrieve

Responses
chevron-right
200Success
application/json
idstringRequired
languagestring · enumRequired

Language used to generate review responses

Possible values:
enabledbooleanRequired
autoTranslatebooleanRequired
brandNamestringRequired

List of brand names associated with the contact form.

get
/public/contact-form
200Success

Submit completed form

post
Body
storestring · uuidOptional

Store identifier to associate

idstring · uuidRequired

Target ID

Example: b6a3aa8c-3a3d-4094-9a7b-015b30d9098f
Responses
post
/public/contact-form/submit
201Success

No content

Get public survey form data

get
Query parameters
trackerstring · uuidOptional

Optional survey tracker ID to associate

storestring · uuidOptional

Optional store ID to associate

brandstring · uuidOptional

Optional brand ID to associate

langstring · enumOptional

Language used to generate review responses

Possible values:
surveystring · uuidRequired

Survey ID to retrieve

Responses
chevron-right
200Success
application/json
idstringRequired
languagestring · enumRequired

Language used to generate review responses

Possible values:
enabledbooleanRequired
autoTranslatebooleanRequired
preRedirectbooleanRequired

@inheritdoc

externalUrlstring · nullableOptional

External url to redirect to on pre-redirect

sendModestring · enumOptional

Type of survey sending

Possible values:
orderstringOptional

External id of the purchase targeted by the survey This is used to identify the purchase in the external system

get
/public/survey
200Success

Submit completed survey

post
Body
trackerstring · uuidOptional

Tracker identifier for private surveys

storestring · uuidOptional

Store identifier for public surveys

brandstring · uuidOptional

Brand identifier for public surveys

idstring · uuidRequired

Target ID

Example: b6a3aa8c-3a3d-4094-9a7b-015b30d9098f
Responses
post
/public/survey/submit
201Success

Last updated