Delete a schedule

Stops it for good and deletes its occurrence records.

DELETE/v1/schedules/{id}

Path Parameters

idstringrequired

Details

Messages it already sent stay in the message log. Scope: messages:send.

Responses

200JSON object
Deleted
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404Error
Not found
429Error
Rate limit or quota exceeded

Response Fields

idstring
objectschedule
deletedboolean

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404
Not found
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/schedules/ID', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
  },
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "object": "schedule"
}