Website Forms (for developers)

This page should serve as a reference to how website forms should present their disclaimer text, and how any submission should be submitted to the lead_conversations resource.

Common form fields

• form -- required -- identifier of what form this is

• sms_okay -- required -- 0 = False, 1 = True

• email_me_more -- required -- 0 = False, 1 = True

• disclaimer -- required -- Contains the text of any disclaimer shown on the form.

• language -- required – “en” for English

• page_referer -- required -- URL of the page making request

• site_url -- required -- base URL of website

• source -- required -- originating site if known, else null

• utm -- required -- any tracking codes passed in from the source

• location_id -- optional, but strongly recommended -- if not provided, will default to the first location associated with the website.

• entity_id -- optional, but strongly recommended if known

• first_name -- optional

• last_name -- optional

• message -- optional

• phone -- optional

• email -- optional

• pet_id -- optional -- send if the request is associated with a specific pet

• breed -- optional -- send if the request is associated with a specific breed

• breed_slug -- deprecated in favor of page_referer

• pet_bday -- optional

• pet_gender -- optional

• recaptchafield.* -- do not send

• Additional fields based on the form.  Labels should be always lowercase with underscores separating words.

Disclaimers

For standard websites, the default disclaimer on any form should be:

I agree to receive pet & promotional information via the options selected below.
[X] It's okay to text me.
[X] It's okay to email me.

The first checkbox would control the sms_okay value and the second email_me_more.  Both should be checked by default. (The disclaimer and checkboxes can be changed upon request.)

In addition to the disclaimer above, the schedule an appointment for a pet form should include in addition the following extra disclaimer.

[X] I'm aware that scheduling an appointment is not reserving this pet for me, and that the pet might get sold.

Shopwindow Integrated Disclaimers

If a website has the Shopwindow integration enabled on it (This is based on an integration being enabled in the POS for the site. The status of the integration can be checked and cached for an extended period of time.)

[X] Yes, Send Me Puppy Information And Any Coupons.

I consent to being contacted via the channels I have provided ie SMS text message/email etc.

The one checkbox sets both sms_okay and email_me_more.  The Shopwindow Terms of Use also needs to be linked to https://sw6.co/4F3X at the bottom of all forms from the text “Shopwindow Terms of Use”.

The disclaimer text, checkboxes, and Terms of Use links may not be changed without the consent of Shopwindow.