PATCH /api/v2/* → behaviour change
Outreach API
Stopped working
On October 31, 2023, the query parameter include stopped working on PATCH /api/v2/* endpoints. Requests to PATCH /api/v2/* that include this parameter fail. The change removes the ability to include related objects directly in update responses.
Calls it hits
PATCH /api/v2/*query parameter include
What to use instead of these calls
Send the POST or PATCH without include, then GET the object (or its related objects) with ?include=… in a second request.
In Outreach API's words
Including related objects to the response of create or update operation Please replace the single POST/PATCH request with two: POST/PATCH of the main object followed by GET request for related objects.
Facts
- API
- Outreach API
api.outreach.io - Kind
- Behaviour change
- Announced
- May 1, 2023
- Takes effect
- October 31, 2023
- Calls after that day
- Fail
- Source
- Announcement
- Last updated
- Verified
- , against Outreach API's own pages
Questions
When does this change take effect?
Calls to PATCH /api/v2/*, query parameter include on Outreach API stopped working on October 31, 2023.
What happens to calls after October 31, 2023?
They have failed since October 31, 2023.
How do I find the calls this hits in my code?
Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.
More from Outreach API 1
-
POST /api/v2/*Behaviour change Stopped working
You fixed this one by hand.
Okapi opens the pull request with the fix before the next breaking change reaches your code.