API Additions and Changes 2018-03-28

API Q&A
1

Good day from Infusionsoft HQ! We’re happy to share the following additions or changes.

REST API

The Infusionsoft API team is hard at work improving usability and documentation.

  • New The REST API now responds with a helpful, informative message when requests with JSON bodies include unexpected properties. Example:

    {
  "message": "Unrecognized property: foo"
}

    Prior to this change, the message was not-so-informative. Example:

    {
  "message": "Input could not be converted to a valid request"
}

  • Update The API documentation for Tags body samples now accurately indicate which properties are available for each request and response; prior to these changes, the request and response body samples were the same which caused confusion and delay. It’s a little nuance that makes a big difference for folks learning the API.

    Example: new, accurate Create Tag request sample:

    {
  "description": "string",
  "category": {
    "id": 0
  },
  "name": "string"
}

    Example: old, inaccurate Create Tag request sample:

    {
  "category": {
    "id": 0,
    "name": "string"
  },
  "name": "string",
  "description": "string"
}

    Example: new, accurate Create Tag response sample:

    {
  "category": {
    "id": 0,
    "name": "string"
  },
  "description": "string",
  "name": "string"
}

    Example: old, inaccurate Create Tag response sample:

    {
  "category": {
    "name": "string",
    "id": 0,
    "description": "string"
  },
  "description": "string",
  "id": 0,
  "name": "string"
}

Meanwhile, work on the Companies resource is well underway.

Also,