Skip to main content
Answered

Documentation and code samples are not aligned. What is the right one?


Documentation in many places is not updated and it is not aligned with the code snippets. For example, the section for Custom attributes:

https://developers.intercom.com/intercom-api-reference/reference#section-request-body-parameters/p>

In request body parameters, 'model' property is understood as a mandatory one. On the other hand, in CURL code snippet, it is missing, instead there is another one, not mentioned in a description, 'company'.

"data_type" property in the code snippet has "options" value, which is not listed in the documentation on the left side.

Also, phrase "Provide a set of hashes..." sounds odd, hash is mostly understood as non-readable representation of the input value, got from the transformation of the input value. From the context we can get a feeling that we just need to provide a set of text key/value pairs.

Overall, the right working code can be get only from the test and trials, which is not very efficient, and can lead to unexpected result.

 

 

intercom-documentation-outdated

Best answer by Sam

Ahh! Nice spot! I've suggested an edit to fix the problems with the documentation on your behalf. Hopefully it will get changed soon.

On behalf of fellow customers, thank you for pointing that out so that it can be fixed! 🙌

View original

Forum|alt.badge.img+1
  • Active User
  • April 9, 2021

Ahh! Nice spot! I've suggested an edit to fix the problems with the documentation on your behalf. Hopefully it will get changed soon.

On behalf of fellow customers, thank you for pointing that out so that it can be fixed! 🙌


  • Active User
  • April 9, 2021

thanks for quick update @user1030​ 


Forum|alt.badge.img+1
  • Active User
  • April 9, 2021

Adding on, the correct documentation is likely the one on the left.


Reply


Cookie policy

We use cookies to enhance and personalize your experience. If you accept you agree to our full cookie policy. Learn more about our cookies.

 
Cookie settings