General updates

  • The URLs for the API endpoints are now api.kit.com/v4/... instead of api.convertkit.com/v3/.... They are otherwise unchanged unless called out specifically below.
  • V4 supports OAuth for applications and API Keys for automating simple tools and integrations for your personal account. V4 API Keys are not compatiblewith V3
  • Our pagination mechanism has changed. We no longer support page or offset based pagination. All of our pagination is now cursor based. This improves performance.
  • All errors are now returned with a consistent response shape. The response is a JSON object with a single attribute errors, an array of strings.
  • See below for a list of endpoints changed

Endpoint specific updates

Accounts

Broadcasts

  • List broadcasts
  • Create a broadcast
    • The email_layout_template param is no longer supported. To specify the email template, use the email_template_id param.
    • The response shape has changed. We no longer return email_layout_template and return an object for email_template.
    • The error response shape has changed.
  • Get a broadcast
    • The response shape has changed. We no longer return email_layout_template and return an object for email_template.
    • The error response shape has changed.
  • Delete a broadcast
  • Update a broadcast
    • The email_layout_template param is no longer supported. To specify the email template, use the email_template_id param.
    • The response shape has changed. We no longer return email_layout_template and return an object for email_template.
    • The error response shape has changed.
  • Get stats
    • The error response shape has changed.

Subscribers

  • List subscribers
    • The page parameter is no longer supported. To request next or previous pages, use the before or after cursor
    • The from parameter is no longer supported. It has been replaced with created_after.
    • The to parameter is no longer supported. It has been replaced with created_before.
    • The updated_from parameter is no longer supported. It has been replaced with updated_after.
    • The updated_to parameter is no longer supported. It has been replaced with updated_before.
  • Get a subscriber
    • The error response shape has changed.
  • Update a subscriber
    • The error response shape has changed.
  • Unsubscribe a subscriber
    • The URL path has changed. /v3/unsubscribe -> /v4/subscribers/:id/unsubscribe
    • We now require you to unsubscribe the subscriber via their id
      • If you need to find their id by email address, you can query with List subscribers, /v4/subscribers?email_address=<email>
    • The response shape has changed. It returns a 204 empty response instead of the subscriber.
    • The error response shape has changed.
  • List tags for a subscriber

Custom Fields

  • Create a custom field
  • Update a custom field

Forms

  • List forms
  • Add subscriber to a form by email address
    • The email parameter is no longer supported. To add a subscriber by email address, use the email_address parameter.
  • List subscribers to a form
    • The URL path has changed. /v3/forms/:id/subscriptions -> /v4/forms/:id/subscribers
    • The response shape has changed. Subscriber information is no longer nested under subscription.

Purchases

  • List purchases
  • Create a purchase
    • The error response shape has changed.

Sequences

  • List sequences
  • Add subscriber to a sequence by email address
    • The email parameter is no longer supported. To add a subscriber by email address, use the email_address parameter.
  • List subscribers to a sequence
    • The URL path has changed. /v3/sequences/:id/subscriptions -> /v4/sequences/:id/subscribers
    • The response shape has changed. Subscriber information is no longer nested under subscription.

Tags

  • Create a tag
  • List subscribers for a tag
    • The URL path has changed. /v3/tags/:id/subscriptions -> /v4/tags/:id/subscribers
    • The page parameter is no longer supported. To request next or previous pages, use the before or after cursor
    • The error response shape has changed.
    • The response shape has changed. The root object is subscribers instead of subscriptions along with other smaller changes.
  • Tag a subscriber
    • The URL path has changed. /v3/tags/:id/subscribe -> /v4/tags/:tag_id/subscribers/:id
    • The response shape has changed. The root object is subscriber instead of subscription along with other smaller changes.
    • The error response shape has changed.
    • None of the optional params from V3 are supported in V4
  • Tag a subscriber by email address
    • The URL path has changed. /v3/tags/:id/subscribe -> /v4/tags/:tag_id/subscribers
    • The email parameter is no longer supported. To add a subscriber by email address, use the email_address parameter.
    • The response shape has changed. The root object is subscriber instead of subscription along with other smaller changes.
    • The error response shape has changed.
    • None of the optional request params from V3 are supported in V4
  • Remove tag from subscriber
    • The URL path and HTTP verb has changed. POST /v3/tags/:id/unsubscribe -> DELETE /v4/tags/:tag_id/subscribers/:id
    • The response shape has changed. We return a 204 empty response
    • The error response shape has changed.
  • Remove tag from subscriber by email address
    • The URL path and HTTP verb has changed. POST /v3/tags/:id/unsubscribe -> DELETE /v4/tags/:tag_id/subscribers/:id
    • The response shape has changed. We return a 204 empty response.
    • The error response shape has changed.

Webhooks

  • The URL paths for webhooks have changed from /automations/hooks to /webhooks.
  • Create a webhook
  • Delete a webhook