{"slug":"close-api","name":"Close API","host":"api.close.com","site":"https://close.com","category":"marketing","docsUrl":null,"sources":[{"kind":"changelog","url":"https://developer.close.com/changelog"},{"kind":"openapi","url":"https://api.close.com/api/openapi.json"},{"kind":"archive","url":"https://developer.close.com/api/overview/changelog/2023/8/29"},{"kind":"archive","url":"https://developer.close.com/api/overview/changelog/2024/12/2"},{"kind":"archive","url":"https://developer.close.com/api/overview/changelog/2026/3/6"},{"kind":"archive","url":"https://developer.close.com/api/overview/changelog/2026/7/21"}],"url":"https://www.okapi.bot/providers/close-api/","json":"https://www.okapi.bot/api/v1/providers/close-api.json","breakingChanges":[{"slug":"schedule-id-on-post-api-v1-sequence-stops-working","api":"close-api","title":"schedule_id on POST /api/v1/sequence/ stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-08-29","effectiveAt":"2023-08-29","scope":null,"calls":["POST /api/v1/sequence","body parameter schedule_id"],"method":"POST","path":"/api/v1/sequence","source":{"url":"https://developer.close.com/api/overview/changelog/2023/8/29","kind":"archive"},"quote":"We have added a new schedule field and removed the existing schedule_id field in the Sequence API.","migration":"Send the sequence's sending hours in the schedule object (ranges of weekday, start and end) instead of schedule_id.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:50.074Z","updatedAt":"2026-10-23T10:14:50.074Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/close-api/breaking-changes/schedule-id-on-post-api-v1-sequence-stops-working/"},{"slug":"schedule-id-on-put-api-v1-sequence-stops-working","api":"close-api","title":"schedule_id on PUT /api/v1/sequence/{} stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2023-08-29","effectiveAt":"2023-08-29","scope":null,"calls":["PUT /api/v1/sequence/{}","body parameter schedule_id"],"method":"PUT","path":"/api/v1/sequence/{}","source":{"url":"https://developer.close.com/api/overview/changelog/2023/8/29","kind":"archive"},"quote":"We have added a new schedule field and removed the existing schedule_id field in the Sequence API.","migration":"Send the sequence's sending hours in the schedule object (ranges of weekday, start and end) instead of schedule_id.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:50.074Z","updatedAt":"2026-10-23T10:14:50.074Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/close-api/breaking-changes/schedule-id-on-put-api-v1-sequence-stops-working/"},{"slug":"applies-to-on-post-api-v1-outcome-is-deprecated","api":"close-api","title":"applies_to on POST /api/v1/outcome/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-06","effectiveAt":null,"scope":null,"calls":["POST /api/v1/outcome","body parameter applies_to"],"method":"POST","path":"/api/v1/outcome","source":{"url":"https://developer.close.com/api/overview/changelog/2026/3/6","kind":"archive"},"quote":"deprecated on write operations (create and update). In a future update, the field will be ignored on create and update requests and will instead be derived from the type field","migration":"Stop sending applies_to; set the outcome's type (custom or vm-dropped), from which Close derives it.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:42.505Z","updatedAt":"2026-10-23T10:14:42.505Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/applies-to-on-post-api-v1-outcome-is-deprecated/"},{"slug":"applies-to-on-put-api-v1-outcome-is-deprecated","api":"close-api","title":"applies_to on PUT /api/v1/outcome/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-03-06","effectiveAt":null,"scope":null,"calls":["PUT /api/v1/outcome/{}","body parameter applies_to"],"method":"PUT","path":"/api/v1/outcome/{}","source":{"url":"https://developer.close.com/api/overview/changelog/2026/3/6","kind":"archive"},"quote":"deprecated on write operations (create and update). In a future update, the field will be ignored on create and update requests and will instead be derived from the type field","migration":"Stop sending applies_to; set the outcome's type (custom or vm-dropped), from which Close derives it.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:42.505Z","updatedAt":"2026-10-23T10:14:42.505Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/applies-to-on-put-api-v1-outcome-is-deprecated/"},{"slug":"is-group-number-on-get-api-v1-phone-number-is-deprecated","api":"close-api","title":"is_group_number on GET /api/v1/phone_number/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-21","effectiveAt":null,"scope":null,"calls":["GET /api/v1/phone_number","query parameter is_group_number"],"method":"GET","path":"/api/v1/phone_number","source":{"url":"https://developer.close.com/api/overview/changelog/2026/7/21","kind":"archive"},"quote":"The user_id and is_group_number fields on the Phone Number API are deprecated, both as query filters when listing phone numbers and as fields in phone number responses.","migration":"Stop filtering on is_group_number; filter by participant_user_id, which also returns the group numbers a user belongs to.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:38.381Z","updatedAt":"2026-10-23T10:14:38.381Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/is-group-number-on-get-api-v1-phone-number-is-deprecated/"},{"slug":"record-calls-on-put-api-v1-membership-is-deprecated","api":"close-api","title":"record_calls on PUT /api/v1/membership/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-12-02","effectiveAt":null,"scope":null,"calls":["PUT /api/v1/membership","body parameter record_calls"],"method":"PUT","path":"/api/v1/membership","source":{"url":"https://developer.close.com/api/overview/changelog/2024/12/2","kind":"archive"},"quote":"The boolean record_calls field on the Membership API has been deprecated in favor of auto_record_calls","migration":"Send auto_record_calls ('enabled' or 'disabled') instead of record_calls.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:46.284Z","updatedAt":"2026-10-23T10:14:46.284Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/record-calls-on-put-api-v1-membership-is-deprecated/"},{"slug":"record-calls-on-put-api-v1-membership-is-deprecated-2","api":"close-api","title":"record_calls on PUT /api/v1/membership/{} is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2024-12-02","effectiveAt":null,"scope":null,"calls":["PUT /api/v1/membership/{}","body parameter record_calls"],"method":"PUT","path":"/api/v1/membership/{}","source":{"url":"https://developer.close.com/api/overview/changelog/2024/12/2","kind":"archive"},"quote":"The boolean record_calls field on the Membership API has been deprecated in favor of auto_record_calls","migration":"Send auto_record_calls ('enabled' or 'disabled') instead of record_calls.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:46.284Z","updatedAt":"2026-10-23T10:14:46.284Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/record-calls-on-put-api-v1-membership-is-deprecated-2/"},{"slug":"sharing-on-post-api-v1-phone-number-request-internal-is-deprecated","api":"close-api","title":"sharing on POST /api/v1/phone_number/request/internal/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-21","effectiveAt":null,"scope":null,"calls":["POST /api/v1/phone_number/request/internal","body parameter sharing"],"method":"POST","path":"/api/v1/phone_number/request/internal","source":{"url":"https://developer.close.com/api/overview/changelog/2026/7/21","kind":"archive"},"quote":"The sharing field on the Request an internal phone number endpoint is deprecated and will be removed in a future update.","migration":"Stop sending sharing for personal numbers; group and personal numbers are being merged, so request the number and assign it with assign_to.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:38.381Z","updatedAt":"2026-10-23T10:14:38.381Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/sharing-on-post-api-v1-phone-number-request-internal-is-deprecated/"},{"slug":"user-id-on-get-api-v1-phone-number-is-deprecated","api":"close-api","title":"user_id on GET /api/v1/phone_number/ is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2026-07-21","effectiveAt":null,"scope":null,"calls":["GET /api/v1/phone_number","query parameter user_id"],"method":"GET","path":"/api/v1/phone_number","source":{"url":"https://developer.close.com/api/overview/changelog/2026/7/21","kind":"archive"},"quote":"The user_id and is_group_number fields on the Phone Number API are deprecated, both as query filters when listing phone numbers and as fields in phone number responses.","migration":"Filter phone numbers by user with the participant_user_id query parameter instead.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:14:38.381Z","updatedAt":"2026-10-23T10:14:38.381Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/close-api/breaking-changes/user-id-on-get-api-v1-phone-number-is-deprecated/"}]}