Okapi Okapi

Close API schedule_id body parameter removal on PUT /api/v1/sequence/{id}

Stopped workingSubscribe to Close APIShare

On August 29, 2023, the Close API removed the body parameter schedule_id on PUT /api/v1/sequence/{id}. Following this change, requests that still use schedule_id fail.


Calls it hits

  • PUT /api/v1/sequence/{id}
  • body parameter schedule_id

What to use instead of these calls

Send the sequence's sending hours in the schedule object with ranges of weekday, start, and end instead of schedule_id.

In Close API's words

We have added a new schedule field and removed the existing schedule_id field in the Sequence API.

Close API, Announcement

Facts

API
Close API api.close.com
Kind
Parameter removal
Announced
August 29, 2023
Takes effect
August 29, 2023
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against Close API's own pages

Questions

When does this change take effect?

Calls to PUT /api/v1/sequence/{id}, body parameter schedule_id on Close API stopped working on August 29, 2023.

What happens to calls after August 29, 2023?

They have failed since August 29, 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 Close API 8

  1. POST /api/v1/sequenceParameter removal Stopped working
  2. No date POST /api/v1/outcomeParameter removal Deprecated, no date
  3. No date PUT /api/v1/outcome/{id}Parameter removal Deprecated, no date
  4. No date GET /api/v1/phone_numberParameter removal Deprecated, no date
  5. No date PUT /api/v1/membershipParameter removal Deprecated, no date
  6. No date PUT /api/v1/membership/{id}Parameter removal Deprecated, no date
  7. No date POST /api/v1/phone_number/request/internalParameter removal Deprecated, no date
  8. No date GET /api/v1/phone_numberParameter removal Deprecated, no date

You fixed this one by hand.

Okapi opens the pull request with the fix before the next breaking change reaches your code.

Add to GitHub

Get notifications

Subscribe to Close API

Hear about each breaking change Close API announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • Close API

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.