Helping you upgrade from V3 of the API to V4
api.kit.com/v4/...
instead of api.convertkit.com/v3/...
. They are otherwise unchanged unless called out specifically below.errors
, an array of strings.user
and account
objects, respectively.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursoremail_layout_template
param is no longer supported. To specify the email template, use the email_template_id
param.
email_layout_template
and return an object for email_template
.email_layout_template
and return an object for email_template
.email_layout_template
param is no longer supported. To specify the email template, use the email_template_id
param.
email_layout_template
and return an object for email_template
.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorfrom
parameter is no longer supported. It has been replaced with created_after
.to
parameter is no longer supported. It has been replaced with created_before
.updated_from
parameter is no longer supported. It has been replaced with updated_after
.updated_to
parameter is no longer supported. It has been replaced with updated_before
./v3/unsubscribe
-> /v4/subscribers/:id/unsubscribe
/v4/subscribers?email_address=<email>
created_at
has been replaced with tagged_at
.custom_field
attribute.custom_field
attribute.email
parameter is no longer supported. To add a subscriber by email address,
use the email_address
parameter./v3/forms/:id/subscriptions
-> /v4/forms/:id/subscribers
subscription
.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorsequences
attributes (instead of a courses
attribute).email
parameter is no longer supported. To add a subscriber by email address, use the email_address
parameter./v3/sequences/:id/subscriptions
-> /v4/sequences/:id/subscribers
subscription
.tag
attribute no longer requiredtag
attribute./v3/tags/:id/subscriptions
-> /v4/tags/:id/subscribers
page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorsubscribers
instead of subscriptions
along with other smaller changes./v3/tags/:id/subscribe
-> /v4/tags/:tag_id/subscribers/:id
subscriber
instead of subscription
along with other smaller changes./v3/tags/:id/subscribe
-> /v4/tags/:tag_id/subscribers
email
parameter is no longer supported. To add a subscriber by email address, use the email_address
parameter.subscriber
instead of subscription
along with other smaller changes.POST /v3/tags/:id/unsubscribe
-> DELETE /v4/tags/:tag_id/subscribers/:id
POST /v3/tags/:id/unsubscribe
-> DELETE /v4/tags/:tag_id/subscribers/:id
/automations/hooks
to /webhooks
.webhook
instead of rule
.Helping you upgrade from V3 of the API to V4
api.kit.com/v4/...
instead of api.convertkit.com/v3/...
. They are otherwise unchanged unless called out specifically below.errors
, an array of strings.user
and account
objects, respectively.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursoremail_layout_template
param is no longer supported. To specify the email template, use the email_template_id
param.
email_layout_template
and return an object for email_template
.email_layout_template
and return an object for email_template
.email_layout_template
param is no longer supported. To specify the email template, use the email_template_id
param.
email_layout_template
and return an object for email_template
.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorfrom
parameter is no longer supported. It has been replaced with created_after
.to
parameter is no longer supported. It has been replaced with created_before
.updated_from
parameter is no longer supported. It has been replaced with updated_after
.updated_to
parameter is no longer supported. It has been replaced with updated_before
./v3/unsubscribe
-> /v4/subscribers/:id/unsubscribe
/v4/subscribers?email_address=<email>
created_at
has been replaced with tagged_at
.custom_field
attribute.custom_field
attribute.email
parameter is no longer supported. To add a subscriber by email address,
use the email_address
parameter./v3/forms/:id/subscriptions
-> /v4/forms/:id/subscribers
subscription
.page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorsequences
attributes (instead of a courses
attribute).email
parameter is no longer supported. To add a subscriber by email address, use the email_address
parameter./v3/sequences/:id/subscriptions
-> /v4/sequences/:id/subscribers
subscription
.tag
attribute no longer requiredtag
attribute./v3/tags/:id/subscriptions
-> /v4/tags/:id/subscribers
page
parameter is no longer supported. To request next or previous pages, use the before
or after
cursorsubscribers
instead of subscriptions
along with other smaller changes./v3/tags/:id/subscribe
-> /v4/tags/:tag_id/subscribers/:id
subscriber
instead of subscription
along with other smaller changes./v3/tags/:id/subscribe
-> /v4/tags/:tag_id/subscribers
email
parameter is no longer supported. To add a subscriber by email address, use the email_address
parameter.subscriber
instead of subscription
along with other smaller changes.POST /v3/tags/:id/unsubscribe
-> DELETE /v4/tags/:tag_id/subscribers/:id
POST /v3/tags/:id/unsubscribe
-> DELETE /v4/tags/:tag_id/subscribers/:id
/automations/hooks
to /webhooks
.webhook
instead of rule
.