ConvertKit_API.md

ConvertKit_API

ConvertKit API Class

• Full name: \ConvertKit_API\ConvertKit_API

Constants

Constant	Visibility	Type	Value
VERSION	public	string	'2.0.0'

Properties

debug

Debug

protected bool $debug

debug_logger

Debug

protected \Monolog\Logger $debug_logger

client

Guzzle Http ClientInterface

protected \GuzzleHttp\ClientInterface $client

response

Guzzle Http Response

protected \Psr\Http\Message\ResponseInterface $response

Methods

__construct

Constructor for ConvertKitAPI instance

public __construct(string $clientID, string $clientSecret, string $accessToken = '', bool $debug = false, string $debugLogFileLocation = ''): mixed

Parameters:

Parameter	Type	Description
$clientID	string	OAuth Client ID.
$clientSecret	string	OAuth Client Secret.
$accessToken	string	OAuth Access Token.
$debug	bool	Log requests to debugger.
$debugLogFileLocation	string	Path and filename of debug file to write to.

---

set_http_client

Set the Guzzle client implementation to use for API requests.

public set_http_client(\GuzzleHttp\ClientInterface $client): void

Parameters:

Parameter	Type	Description
$client	\GuzzleHttp\ClientInterface	Guzzle client implementation.

---

create_log

Add an entry to monologger.

private create_log(string $message): void

Parameters:

Parameter	Type	Description
$message	string	Message.

---

get_oauth_url

Returns the OAuth URL to begin the OAuth process.

public get_oauth_url(string $redirectURI): string

Parameters:

Parameter	Type	Description
$redirectURI	string	Redirect URI.

---

get_access_token

Exchanges the given authorization code for an access token and refresh token.

public get_access_token(string $authCode, string $redirectURI): array<string,int|string>

Parameters:

Parameter	Type	Description
$authCode	string	Authorization Code, returned from get_oauth_url() flow.
$redirectURI	string	Redirect URI.

Return Value:

API response

---

refresh_token

Fetches a new access token using the supplied refresh token.

public refresh_token(string $refreshToken, string $redirectURI): array<string,int|string>

Parameters:

Parameter	Type	Description
$refreshToken	string	Refresh Token.
$redirectURI	string	Redirect URI.

Return Value:

API response

---

get_resource

Get markup from ConvertKit for the provided $url.

public get_resource(string $url): false|string

Supports legacy forms and legacy landing pages.

Forms and Landing Pages should be embedded using the supplied JS embed script in the API response when using get_forms() or get_landing_pages().

Parameters:

Parameter	Type	Description
$url	string	URL of HTML page.

---

request

Performs an API request using Guzzle.

public request(string $endpoint, string $method, array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>> $args = []): false|mixed

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$method	string	Request method.
$args	array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>>	Request arguments.

---

getResponseInterface

Returns the response interface used for the last API request.

public getResponseInterface(): \Psr\Http\Message\ResponseInterface

---

get_request_headers

Returns the headers to use in an API request.

public get_request_headers(string $type = 'application/json', bool $auth = true): array<string,string>

Parameters:

Parameter	Type	Description
$type	string	Accept and Content-Type Headers.
$auth	bool	Include authorization header.

---

get_timeout

Returns the maximum amount of time to wait for a response to the request before exiting.

public get_timeout(): int

Return Value:

Timeout, in seconds.

---

get_user_agent

Returns the user agent string to use in all HTTP requests.

public get_user_agent(): string

---

Inherited methods

get_account

Gets the current account

public get_account(): false|mixed

See Also:

• https://developers.convertkit.com/v4.html#get-current-account

---

get_account_colors

Gets the account's colors

public get_account_colors(): false|mixed

See Also:

• https://developers.convertkit.com/v4.html#list-colors

---

update_account_colors

Gets the account's colors

public update_account_colors(array<string,string> $colors): false|mixed

Parameters:

Parameter	Type	Description
$colors	array<string,string>	Hex colors.

See Also:

• https://developers.convertkit.com/v4.html#list-colors

---

get_creator_profile

Gets the Creator Profile

public get_creator_profile(): false|mixed

See Also:

• https://developers.convertkit.com/v4.html#get-creator-profile

---

get_email_stats

Gets email stats

public get_email_stats(): false|mixed

See Also:

• https://developers.convertkit.com/v4.html#get-email-stats

---

get_growth_stats

Gets growth stats

public get_growth_stats(\DateTime $starting = null, \DateTime $ending = null): false|mixed

Parameters:

Parameter	Type	Description
$starting	\DateTime	Gets stats for time period beginning on this date. Defaults to 90 days ago.
$ending	\DateTime	Gets stats for time period ending on this date. Defaults to today.

See Also:

• https://developers.convertkit.com/v4.html#get-growth-stats

---

get_forms

Get forms.

public get_forms(string $status = 'active', bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|array<int,\stdClass>

Parameters:

Parameter	Type	Description
$status	string	Form status (active|archived|trashed|all).
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#convertkit-api-forms

---

get_landing_pages

Get landing pages.

public get_landing_pages(string $status = 'active', bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|array<int,\stdClass>

Parameters:

Parameter	Type	Description
$status	string	Form status (active|archived|trashed|all).
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#convertkit-api-forms

---

add_subscriber_to_form_by_email

Adds a subscriber to a form by email address

public add_subscriber_to_form_by_email(int $form_id, string $email_address): false|mixed

Parameters:

Parameter	Type	Description
$form_id	int	Form ID.
$email_address	string	Email Address.

See Also:

• https://developers.convertkit.com/v4.html#add-subscriber-to-form-by-email-address

---

add_subscriber_to_form

Adds a subscriber to a form by subscriber ID

public add_subscriber_to_form(int $form_id, int $subscriber_id): false|mixed

Parameters:

Parameter	Type	Description
$form_id	int	Form ID.
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#add-subscriber-to-form

---

get_form_subscriptions

List subscribers for a form

public get_form_subscriptions(int $form_id, string $subscriber_state = 'active', \DateTime $created_after = null, \DateTime $created_before = null, \DateTime $added_after = null, \DateTime $added_before = null, bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$form_id	int	Form ID.
$subscriber_state	string	Subscriber State (active|bounced|cancelled|complained|inactive).
$created_after	\DateTime	Filter subscribers who have been created after this date.
$created_before	\DateTime	Filter subscribers who have been created before this date.
$added_after	\DateTime	Filter subscribers who have been added to the form after this date.
$added_before	\DateTime	Filter subscribers who have been added to the form before this date.
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-subscribers-for-a-form

---

get_sequences

Gets sequences

public get_sequences(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-sequences

---

add_subscriber_to_sequence_by_email

Adds a subscriber to a sequence by email address

public add_subscriber_to_sequence_by_email(int $sequence_id, string $email_address): false|mixed

Parameters:

Parameter	Type	Description
$sequence_id	int	Sequence ID.
$email_address	string	Email Address.

See Also:

• https://developers.convertkit.com/v4.html#add-subscriber-to-sequence-by-email-address

---

add_subscriber_to_sequence

Adds a subscriber to a sequence by subscriber ID

public add_subscriber_to_sequence(int $sequence_id, int $subscriber_id): false|mixed

Parameters:

Parameter	Type	Description
$sequence_id	int	Sequence ID.
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#add-subscriber-to-sequence

---

get_sequence_subscriptions

List subscribers for a sequence

public get_sequence_subscriptions(int $sequence_id, string $subscriber_state = 'active', \DateTime $created_after = null, \DateTime $created_before = null, \DateTime $added_after = null, \DateTime $added_before = null, bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$sequence_id	int	Sequence ID.
$subscriber_state	string	Subscriber State (active|bounced|cancelled|complained|inactive).
$created_after	\DateTime	Filter subscribers who have been created after this date.
$created_before	\DateTime	Filter subscribers who have been created before this date.
$added_after	\DateTime	Filter subscribers who have been added to the form after this date.
$added_before	\DateTime	Filter subscribers who have been added to the form before this date.
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-subscribers-for-a-sequence

---

get_tags

List tags.

public get_tags(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|array<int,\stdClass>

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-tags

---

create_tag

Creates a tag.

public create_tag(string $tag): false|mixed

Parameters:

Parameter	Type	Description
$tag	string	Tag Name.

See Also:

• https://developers.convertkit.com/v4.html#create-a-tag

---

create_tags

Creates multiple tags.

public create_tags(array<int,string> $tags, string $callback_url = ''): false|mixed

Parameters:

Parameter	Type	Description
$tags	array<int,string>	Tag Names.
$callback_url	string	URL to notify for large batch size when async processing complete.

See Also:

• https://developers.convertkit.com/v4.html#bulk-create-tags

---

tag_subscriber_by_email

Tags a subscriber with the given existing Tag.

public tag_subscriber_by_email(int $tag_id, string $email_address): false|mixed

Parameters:

Parameter	Type	Description
$tag_id	int	Tag ID.
$email_address	string	Email Address.

See Also:

• https://developers.convertkit.com/v4.html#tag-a-subscriber-by-email-address

---

tag_subscriber

Tags a subscriber by subscriber ID with the given existing Tag.

public tag_subscriber(int $tag_id, int $subscriber_id): false|mixed

Parameters:

Parameter	Type	Description
$tag_id	int	Tag ID.
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#tag-a-subscriber

---

remove_tag_from_subscriber

Removes a tag from a subscriber.

public remove_tag_from_subscriber(int $tag_id, int $subscriber_id): false|mixed

Parameters:

Parameter	Type	Description
$tag_id	int	Tag ID.
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#remove-tag-from-subscriber

---

remove_tag_from_subscriber_by_email

Removes a tag from a subscriber by email address.

public remove_tag_from_subscriber_by_email(int $tag_id, string $email_address): false|mixed

Parameters:

Parameter	Type	Description
$tag_id	int	Tag ID.
$email_address	string	Subscriber email address.

See Also:

• https://developers.convertkit.com/v4.html#remove-tag-from-subscriber-by-email-address

---

get_tag_subscriptions

List subscribers for a tag

public get_tag_subscriptions(int $tag_id, string $subscriber_state = 'active', \DateTime $created_after = null, \DateTime $created_before = null, \DateTime $tagged_after = null, \DateTime $tagged_before = null, bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$tag_id	int	Tag ID.
$subscriber_state	string	Subscriber State (active|bounced|cancelled|complained|inactive).
$created_after	\DateTime	Filter subscribers who have been created after this date.
$created_before	\DateTime	Filter subscribers who have been created before this date.
$tagged_after	\DateTime	Filter subscribers who have been tagged after this date.
$tagged_before	\DateTime	Filter subscribers who have been tagged before this date.
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-subscribers-for-a-tag

---

get_email_templates

List email templates.

public get_email_templates(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#convertkit-api-email-templates

---

get_subscribers

List subscribers.

public get_subscribers(string $subscriber_state = 'active', string $email_address = '', \DateTime $created_after = null, \DateTime $created_before = null, \DateTime $updated_after = null, \DateTime $updated_before = null, string $sort_field = 'id', string $sort_order = 'desc', bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$subscriber_state	string	Subscriber State (active|bounced|cancelled|complained|inactive).
$email_address	string	Search susbcribers by email address. This is an exact match search.
$created_after	\DateTime	Filter subscribers who have been created after this date.
$created_before	\DateTime	Filter subscribers who have been created before this date.
$updated_after	\DateTime	Filter subscribers who have been updated after this date.
$updated_before	\DateTime	Filter subscribers who have been updated before this date.
$sort_field	string	Sort Field (id|updated_at|cancelled_at).
$sort_order	string	Sort Order (asc|desc).
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-subscribers

---

create_subscriber

Create a subscriber.

public create_subscriber(string $email_address, string $first_name = '', string $subscriber_state = '', array<string,string> $fields = []): mixed

Behaves as an upsert. If a subscriber with the provided email address does not exist, it creates one with the specified first name and state. If a subscriber with the provided email address already exists, it updates the first name.

Parameters:

Parameter	Type	Description
$email_address	string	Email Address.
$first_name	string	First Name.
$subscriber_state	string	Subscriber State (active|bounced|cancelled|complained|inactive).
$fields	array<string,string>	Custom Fields.

See Also:

• https://developers.convertkit.com/v4.html#create-a-subscriber

---

create_subscribers

Create multiple subscribers.

public create_subscribers(array<int,array<string,string>> $subscribers, string $callback_url = ''): mixed

Parameters:

Parameter	Type	Description
$subscribers	array<int,array<string,string>>	Subscribers.
$callback_url	string	URL to notify for large batch size when async processing complete.

See Also:

• https://developers.convertkit.com/v4.html#bulk-create-subscribers

---

get_subscriber_id

Get the ConvertKit subscriber ID associated with email address if it exists.

public get_subscriber_id(string $email_address): false|int

Return false if subscriber not found.

Parameters:

Parameter	Type	Description
$email_address	string	Email Address.

See Also:

• https://developers.convertkit.com/v4.html#get-a-subscriber

---

get_subscriber

Get subscriber by id

public get_subscriber(int $subscriber_id): false|int

Parameters:

Parameter	Type	Description
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#get-a-subscriber

---

update_subscriber

Updates the information for a single subscriber.

public update_subscriber(int $subscriber_id, string $first_name = '', string $email_address = '', array<string,string> $fields = []): false|mixed

Parameters:

Parameter	Type	Description
$subscriber_id	int	Existing Subscriber ID.
$first_name	string	New First Name.
$email_address	string	New Email Address.
$fields	array<string,string>	Updated Custom Fields.

See Also:

• https://developers.convertkit.com/v4.html#update-a-subscriber

---

unsubscribe_by_email

Unsubscribe an email address.

public unsubscribe_by_email(string $email_address): false|object

Parameters:

Parameter	Type	Description
$email_address	string	Email Address.

See Also:

• https://developers.convertkit.com/v4.html#unsubscribe-subscriber

---

unsubscribe

Unsubscribe the given subscriber ID.

public unsubscribe(int $subscriber_id): false|object

Parameters:

Parameter	Type	Description
$subscriber_id	int	Subscriber ID.

See Also:

• https://developers.convertkit.com/v4.html#unsubscribe-subscriber

---

get_subscriber_tags

Get a list of the tags for a subscriber.

public get_subscriber_tags(int $subscriber_id, bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|array<int,\stdClass>

Parameters:

Parameter	Type	Description
$subscriber_id	int	Subscriber ID.
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-tags-for-a-subscriber

---

get_broadcasts

List broadcasts.

public get_broadcasts(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-broadcasts

---

create_broadcast

Creates a broadcast.

public create_broadcast(string $subject = '', string $content = '', string $description = '', bool $public = false, \DateTime $published_at = null, \DateTime $send_at = null, string $email_address = '', string $email_template_id = '', string $thumbnail_alt = '', string $thumbnail_url = '', string $preview_text = '', array<string,string> $subscriber_filter = []): false|object

Parameters:

Parameter	Type	Description
$subject	string	The broadcast email's subject.
$content	string	The broadcast's email HTML content.
$description	string	An internal description of this broadcast.
$public	bool	Specifies whether or not this is a public post.
$published_at	\DateTime	Specifies the time that this post was published (applicable only to public posts).
$send_at	\DateTime	Time that this broadcast should be sent; leave blank to create a draft broadcast. If set to a future time, this is the time that the broadcast will be scheduled to send.
$email_address	string	Sending email address; leave blank to use your account's default sending email address.
$email_template_id	string	ID of the email template to use; leave blank to use your account's default email template.
$thumbnail_alt	string	Specify the ALT attribute of the public thumbnail image (applicable only to public posts).
$thumbnail_url	string	Specify the URL of the thumbnail image to accompany the broadcast post (applicable only to public posts).
$preview_text	string	Specify the preview text of the email.
$subscriber_filter	array<string,string>	Filter subscriber(s) to send the email to.

See Also:

• https://developers.convertkit.com/v4.html#create-a-broadcast

---

get_broadcast

Retrieve a specific broadcast.

public get_broadcast(int $id): false|object

Parameters:

Parameter	Type	Description
$id	int	Broadcast ID.

See Also:

• https://developers.convertkit.com/v4.html#get-a-broadcast

---

get_broadcast_stats

Get the statistics (recipient count, open rate, click rate, unsubscribe count, total clicks, status, and send progress) for a specific broadcast.

public get_broadcast_stats(int $id): false|object

Parameters:

Parameter	Type	Description
$id	int	Broadcast ID.

See Also:

• https://developers.convertkit.com/v4.html#get-stats

---

update_broadcast

Updates a broadcast.

public update_broadcast(int $id, string $subject = '', string $content = '', string $description = '', bool $public = false, \DateTime $published_at = null, \DateTime $send_at = null, string $email_address = '', string $email_template_id = '', string $thumbnail_alt = '', string $thumbnail_url = '', string $preview_text = '', array<string,string> $subscriber_filter = []): false|object

Parameters:

Parameter	Type	Description
$id	int	Broadcast ID.
$subject	string	The broadcast email's subject.
$content	string	The broadcast's email HTML content.
$description	string	An internal description of this broadcast.
$public	bool	Specifies whether or not this is a public post.
$published_at	\DateTime	Specifies the time that this post was published (applicable only to public posts).
$send_at	\DateTime	Time that this broadcast should be sent; leave blank to create a draft broadcast. If set to a future time, this is the time that the broadcast will be scheduled to send.
$email_address	string	Sending email address; leave blank to use your account's default sending email address.
$email_template_id	string	ID of the email template to use; leave blank to use your account's default email template.
$thumbnail_alt	string	Specify the ALT attribute of the public thumbnail image (applicable only to public posts).
$thumbnail_url	string	Specify the URL of the thumbnail image to accompany the broadcast post (applicable only to public posts).
$preview_text	string	Specify the preview text of the email.
$subscriber_filter	array<string,string>	Filter subscriber(s) to send the email to.

See Also:

• https://developers.convertkit.com/#create-a-broadcast

---

delete_broadcast

Deletes an existing broadcast.

public delete_broadcast(int $id): false|object

Parameters:

Parameter	Type	Description
$id	int	Broadcast ID.

See Also:

• https://developers.convertkit.com/v4.html#delete-a-broadcast

---

get_webhooks

List webhooks.

public get_webhooks(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-webhooks

---

create_webhook

Creates a webhook that will be called based on the chosen event types.

public create_webhook(string $url, string $event, string $parameter = ''): false|object

Parameters:

Parameter	Type	Description
$url	string	URL to receive event.
$event	string	Event to subscribe to.
$parameter	string	Optional parameter depending on the event.

See Also:

• https://developers.convertkit.com/v4.html#create-a-webhook

---

delete_webhook

Deletes an existing webhook.

public delete_webhook(int $id): false|object

Parameters:

Parameter	Type	Description
$id	int	Webhook ID.

See Also:

• https://developers.convertkit.com/v4.html#delete-a-webhook

---

get_custom_fields

List custom fields.

public get_custom_fields(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-custom-fields

---

create_custom_field

Creates a custom field.

public create_custom_field(string $label): false|object

Parameters:

Parameter	Type	Description
$label	string	Custom Field label.

See Also:

• https://developers.convertkit.com/v4.html#create-a-custom-field

---

create_custom_fields

Creates multiple custom fields.

public create_custom_fields(string[] $labels, string $callback_url = ''): false|object

Parameters:

Parameter	Type	Description
$labels	string[]	Custom Fields labels.
$callback_url	string	URL to notify for large batch size when async processing complete.

See Also:

• https://developers.convertkit.com/v4.html#bulk-create-custom-fields

---

update_custom_field

Updates an existing custom field.

public update_custom_field(int $id, string $label): false|object

Parameters:

Parameter	Type	Description
$id	int	Custom Field ID.
$label	string	Updated Custom Field label.

See Also:

• https://developers.convertkit.com/v4.html#update-a-custom-field

---

delete_custom_field

Deletes an existing custom field.

public delete_custom_field(int $id): false|object

Parameters:

Parameter	Type	Description
$id	int	Custom Field ID.

See Also:

• https://developers.convertkit.com/#destroy-field

---

get_purchases

List purchases.

public get_purchases(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#list-purchases

---

get_purchase

Retuns a specific purchase.

public get_purchase(int $purchase_id): false|object

Parameters:

Parameter	Type	Description
$purchase_id	int	Purchase ID.

See Also:

• https://developers.convertkit.com/v4.html#get-a-purchase

---

create_purchase

Creates a purchase.

public create_purchase(string $email_address, string $transaction_id, array<string,int|float|string> $products, string $currency = 'USD', string $first_name = null, string $status = null, float $subtotal, float $tax, float $shipping, float $discount, float $total, \DateTime $transaction_time = null): false|object

Parameters:

Parameter	Type	Description
$email_address	string	Email Address.
$transaction_id	string	Transaction ID.
$products	array<string,int|float|string>	Products.
$currency	string	ISO Currency Code.
$first_name	string	First Name.
$status	string	Order Status.
$subtotal	float	Subtotal.
$tax	float	Tax.
$shipping	float	Shipping.
$discount	float	Discount.
$total	float	Total.
$transaction_time	\DateTime	Transaction date and time.

See Also:

• https://developers.convertkit.com/v4.html#create-a-purchase

---

get_segments

List segments.

public get_segments(bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): false|mixed

Parameters:

Parameter	Type	Description
$include_total_count	bool	To include the total count of records in the response, use true.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

See Also:

• https://developers.convertkit.com/v4.html#convertkit-api-segments

---

convert_relative_to_absolute_urls

Converts any relative URls to absolute, fully qualified HTTP(s) URLs for the given DOM Elements.

public convert_relative_to_absolute_urls(\DOMNodeList<\DOMElement> $elements, string $attribute, string $url): void

Parameters:

Parameter	Type	Description
$elements	\DOMNodeList<\DOMElement>	Elements.
$attribute	string	HTML Attribute.
$url	string	Absolute URL to prepend to relative URLs.

---

strip_html_head_body_tags

Strips , and opening and closing tags from the given markup, as well as the Content-Type meta tag we might have added in get_html().

public strip_html_head_body_tags(string $markup): string

Parameters:

Parameter	Type	Description
$markup	string	HTML Markup.

Return Value:

HTML Markup

---

build_total_count_and_pagination_params

Adds total count and pagination parameters to the given array of existing API parameters.

private build_total_count_and_pagination_params(array<string,string|int|bool> $params = [], bool $include_total_count = false, string $after_cursor = '', string $before_cursor = '', int $per_page = 100): array<string,string|int|bool>

Parameters:

Parameter	Type	Description
$params	array<string,string|int|bool>	API parameters.
$include_total_count	bool	Return total count of records.
$after_cursor	string	Return results after the given pagination cursor.
$before_cursor	string	Return results before the given pagination cursor.
$per_page	int	Number of results to return.

---

get

Performs a GET request to the API.

public get(string $endpoint, array<string,int|string|bool|array<string,int|string>> $args = []): false|mixed

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$args	array<string,int|string|bool|array<string,int|string>>	Request arguments.

---

post

Performs a POST request to the API.

public post(string $endpoint, array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>> $args = []): false|mixed

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$args	array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>>	Request arguments.

---

put

Performs a PUT request to the API.

public put(string $endpoint, array<string,bool|int|string|array<string,int|string>> $args = []): false|mixed

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$args	array<string,bool|int|string|array<string,int|string>>	Request arguments.

---

delete

Performs a DELETE request to the API.

public delete(string $endpoint, array<string,int|string|array<string,int|string>> $args = []): false|mixed

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$args	array<string,int|string|array<string,int|string>>	Request arguments.

---

request

Performs an API request.

public request(string $endpoint, string $method, array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>> $args = []): false|mixed

• This method is abstract.

Parameters:

Parameter	Type	Description
$endpoint	string	API Endpoint.
$method	string	Request method.
$args	array<string,bool|int|float|string|null|array<int|string,float|int|string|(string)[]>>	Request arguments.

---

get_request_headers

Returns the headers to use in an API request.

public get_request_headers(string $type = 'application/json', bool $auth = true): array<string,string>

• This method is abstract.

Parameters:

Parameter	Type	Description
$type	string	Accept and Content-Type Headers.
$auth	bool	Include authorization header.

---

get_timeout

Returns the maximum amount of time to wait for a response to the request before exiting.

public get_timeout(): int

• This method is abstract.

Return Value:

Timeout, in seconds.

---

get_user_agent

Returns the user agent string to use in all HTTP requests.

public get_user_agent(): string

• This method is abstract.

---