topic Re: What is the API call to add valid values to an added multiple checkboxes field in APIs & Integrations

What is the API call to add valid values to an added multiple checkboxes field

ANDawson60 — Thu, 20 May 2021 15:01:29 GMT

We have created a multiple checkboxes control in CRM to attach as a Contact attribute.
What is the API call that can be used to maintain the valid values on that multiple checkbox control?

We need to pass and align those values with a source system which is the owner of those values. I cannot ascertain from the CRM API how to maintain the valid values attached to a multiple checkbox control.

Re: What is the API call to add valid values to an added multiple checkboxes field

dennisedson — Fri, 21 May 2021 15:27:29 GMT

Hey@ANDawson60

What do you mean by "valid values"?

@tominal , @zaklein might have some input 🤔

Re: What is the API call to add valid values to an added multiple checkboxes field

zaklein — Fri, 21 May 2021 16:02:11 GMT

Hi @ANDawson60

I'm guessing you mean defining/updating the valid value options of a given enumeration property (e.g. multi-select, radio checkbox etc.). If so, you'll want to read HubSpot's Properties API docs. For any given existing property, you can update the valid value options by calling the "Update a property" endpoint (there's also a batch endpoint). For example, my JSON body for a PATCH request to https://api.hubapi.com/crm/v3/properties/objectType/propertyName might be something like:

{ "options": [ { "label": "Option A", "value": "A" }, { "label": "Option B", "value": "B" } ] }

Note that the above would overwrite any existing valid value options of the property (only where it's not set on an existing record), so you'll need to be mindful of how you update the options.

Let me know if you have any follow up questions.

All the best,

Zach

Re: What is the API call to add valid values to an added multiple checkboxes field

ANDawson60 — Thu, 17 Jun 2021 20:02:11 GMT

Thanks all - we identified this as the needing the call from v1 (although I have not tried your call above for comparison)
https://api.hubapi.com/properties/v1/contacts/properties/named/internal_lists?hapikey=####
and then as you point out we must pass the whole list as it is a replace operation not update.

Re: What is the API call to add valid values to an added multiple checkboxes field

AMcKernan — Tue, 31 Oct 2023 08:59:26 GMT

In a scenario where I already had Option A and Option B in there, as described, but wanted to add only a third option C, could I send the above call only containing a single value for Option C, or would I need to resend Option A and Option B in the call to keep those values intact?