API Docs Could Use Some More Detail

As I’ve started to use the API more and more, I’ve found that I have needed to reach out to support to understand some basic functionality. Some examples are:

  • How to add one or multiple tags when calling the Contact PUT or POST methods is not documented in detail. It says to use a String but the format of that string is not documented.
  • How to add values for MultiSelect fields is not documented in detail.

Those are two I just ran into recently but it would be nice to have a section of the docs that details the formatting needed for every type of field possible.

1 Like

Hello Paul

Thank you for your valuable feedback and for diving deep into our API!

You’ve raised a great point. While we’ve aimed to cover the general aspects of API usage in our documentation, we understand that certain edge cases such as formatting for specific field types like Tags or Multi-Select fields may not always be detailed to the level you need during implementation.

That’s exactly where our Live Chat Support team steps in to assist with these custom use cases and help clarify formatting or behavior that might vary depending on your configuration.

That said, your feedback is absolutely valid, and we’ll be forwarding this to our documentation team. Improving the field formatting reference for all field types (including examples for Tags, Multi-Select, and others) is something we’d love to enhance to reduce dependency and increase clarity for developers like you.

Appreciate you taking the time to point this out and please keep the suggestions coming!