Documentation updates for API Reference page

Effective from: August 4, 2021

Here are the most recent updates to our API Reference page:

1. We documented the required flag for the name parameter for POST /dealFields , POST /personFields and POST /organizationFields endpoints to reflect the actual functionality;

2. We added product and related_objects objects to GET /deals/{id}/products response schema;

3. We corrected the type of the user_id parameter from query parameter to body parameter for DELETE /roles/{id}/assignments ;

4. For POST /goals endpoint, we fixed the description of the interval body parameter and changed it to accept application/json instead of application/x-www-form-urlencoded to reflect reality;

5. We documented the add_visible_flag body parameter in the documentation of the following six endpoints:

  • POST /dealFields
  • PUT /dealFields
  • POST /personFields
  • PUT /personFields
  • POST /organizationFields
  • PUT /organizationFields

See more about recent changes announced in our Changelog!

1 Like