{"slug":"outreach-api","name":"Outreach API","host":"api.outreach.io","site":"https://outreach.io","category":"marketing","docsUrl":null,"sources":[{"kind":"changelog","url":"https://developers.outreach.io/api/release-notes"},{"kind":"openapi","url":"https://developers.outreach.io/_spec/api/reference.yaml"},{"kind":"archive","url":"https://developers.outreach.io/api/deprecated-features"}],"url":"https://www.okapi.bot/providers/outreach-api/","json":"https://www.okapi.bot/api/v1/providers/outreach-api.json","breakingChanges":[{"slug":"include-on-patch-api-v2-stops-working","api":"outreach-api","title":"include on PATCH /api/v2/* stops working","kind":"behaviour_change","outcome":"fails","model":null,"announcedAt":"2023-05-01","effectiveAt":"2023-10-31","scope":null,"calls":["PATCH /api/v2/*","query parameter include"],"method":"PATCH","path":"/api/v2/*","source":{"url":"https://developers.outreach.io/api/deprecated-features","kind":"archive"},"quote":"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.","migration":"Send the POST or PATCH without include, then GET the object (or its related objects) with ?include=… in a second request.","migrationChange":null,"needsDecision":null,"text":{"summary":"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.","migration":"Send the POST or PATCH without include, then GET the object (or its related objects) with ?include=… in a second request.","by":"writer"},"publishedAt":"2026-10-23T10:17:16.243Z","updatedAt":"2026-10-25T09:33:01.147Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/outreach-api/breaking-changes/include-on-patch-api-v2-stops-working/"},{"slug":"include-on-post-api-v2-stops-working","api":"outreach-api","title":"include on POST /api/v2/* stops working","kind":"behaviour_change","outcome":"fails","model":null,"announcedAt":"2023-05-01","effectiveAt":"2023-10-31","scope":null,"calls":["POST /api/v2/*","query parameter include"],"method":"POST","path":"/api/v2/*","source":{"url":"https://developers.outreach.io/api/deprecated-features","kind":"archive"},"quote":"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.","migration":"Send the POST or PATCH without include, then GET the object (or its related objects) with ?include=… in a second request.","migrationChange":null,"needsDecision":null,"text":{"summary":"On October 31, 2023, Outreach API changed how it handles the query parameter include on POST /api/v2/* endpoints. Requests using this parameter to return related objects during create or update operations now fail. Calls to POST /api/v2/* can no longer include related resources directly in the response.","migration":"Send the POST or PATCH without include, then issue a second GET request for the object or its related objects with ?include=….","by":"writer"},"publishedAt":"2026-10-23T10:17:16.243Z","updatedAt":"2026-10-25T09:33:01.687Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/outreach-api/breaking-changes/include-on-post-api-v2-stops-working/"}]}