topic Re: API - Form Submit properties for multiple checkboxes in APIs & Integrations

API - Form Submit properties for multiple checkboxes

ryanwinchester — Thu, 14 Jul 2016 21:58:48 GMT

I am having a problem figuring out how to format the data for submitting a multiple checkbox property.

I have tried every combination of any values and keys I could think of.

What would make sense to me is something like:

{
  "property_name":  ["internal_value1", "internal_value2"]
};

or even

{
  "property_name": [
    {"internal_value1": true},
    {"internal_value2": true}
  ]
};

Anybody know the magical phrase to unlock the special secrets?

Re: API - Form Submit properties for multiple checkboxes

zwolfson — Thu, 14 Jul 2016 22:37:29 GMT

Hey @ryanwinchester,

You can send the selected options as strings with each option separated by a semi-colon.

{
"property_name":"internal_value1;internal_value2"
}

Thanks,
Zack

Re: API - Form Submit properties for multiple checkboxes

ryanwinchester — Thu, 14 Jul 2016 22:38:52 GMT

Thanks, that worked!

Where did you find this info?

Re: API - Form Submit properties for multiple checkboxes

zwolfson — Thu, 14 Jul 2016 23:02:18 GMT

I went into the UI for a contact property, checked multiple options for a checkbox property, then did a GET for that contact and looked at the format. I’m going to be updating the documentation over the next few days to provide some examples of this.

Re: API - Form Submit properties for multiple checkboxes

ryanwinchester — Thu, 14 Jul 2016 23:46:20 GMT

I’m starting the process of compiling “gotchas” here

Re: API - Form Submit properties for multiple checkboxes

joewalsh — Sat, 03 Mar 2018 17:55:59 GMT

Unfortunately, this doesn't work any longer. I also couldn't find any documentation of this apart from this thread. Any ideas how to make it work?

Re: API - Form Submit properties for multiple checkboxes

zwolfson — Mon, 05 Mar 2018 14:56:14 GMT

Hi @joe_walsh,

Semicolon-separated values are still working for me. They are documented in our FAQs section here: https://developers.hubspot.com/docs/faq/how-do-i-set-multiple-values-for-checkbox-properties

If that doesn't get you going, feel free to post the POST body you are sending into HubSpot so I can help in more detail.

-Zack

Re: API - Form Submit properties for multiple checkboxes

joewalsh — Mon, 05 Mar 2018 16:13:06 GMT

Hi Zack,

Thanks for your response. While this does work when you update a contact directly (I can confirm as well), it doesn't work for what this discussion thread is about: Sending multi-checkbox values through the Forms API.

Can you give it a try and let me know if sending multiple values through the Forms API works for you?

Re: API - Form Submit properties for multiple checkboxes

zwolfson — Mon, 05 Mar 2018 18:11:00 GMT

Hey @joe_walsh,

Sorry about that, I should have clarified that I did use the Forms API. Here is a screesnhot of what I sent in via Postman

Let me know if that doesn't work for you for some reason.

-Zack

Re: API - Form Submit properties for multiple checkboxes

Qiniso — Wed, 02 Nov 2022 10:45:32 GMT

After trying different combinations, I eventually got it right by adding a space after the semi-colon.

Re: API - Form Submit properties for multiple checkboxes

KLewis28 — Wed, 23 Oct 2024 06:50:29 GMT

I reviewed the UI for a contact property, selected multiple options for a checkbox property, and performed a GET request to inspect the format. Over the next few days, I will be updating the documentation to include examples based on this process.