ConvertKit's official PHP SDK
- Download or clone this repository
- Run
composer install - Add
./vendor/autoload.phpto your project
If your project uses Composer, you can install the ConvertKitSDK-PHP package as a composer package. This allows you to have this project as a dependency without the ConvertKitSDK-PHP files being checked into your source code.
composer require convertkit/convertkitapi:dev-masterPlease note that since ConvertKitSDK-PHP is not yet versioned, your project will always download the latest files from master every time you run composer install which may subject you to breaking changes in the future.
Get your ConvertKit API Key and API Secret here and set it somewhere in your application.
$api = new \ConvertKit_API\ConvertKit_API($api_key, $api_secret);Subscribe to a form
Add a subscriber to a form. The $subscribed response will be an object.
$tag_id = '99999'; // This tag must be valid for your ConvertKit account.
$options = [
'email' => '[email protected]',
'name' => 'Full Name',
'first_name' => 'First Name',
'tags' => $tag_id,
'fields' => [
'phone' => 134567891243,
'shirt_size' => 'M',
'website_url' => 'testurl.com'
]
];
$subscribed = $api->form_subscribe($this->test_form_id, $options);Get Subscriber ID
Get the ConvertKit Subscriber ID for a given email address.
$subscriber_id = $api->get_subscriber_id( $email );Get Subscriber
Get subscriber data for a ConvertKit Subscriber.
$subscriber = $api->get_subscriber( $subscriber_id );Get Subscriber Tags
Get all tags applied to a Subscriber.
$subscriber_tags = $api->get_subscriber_tags( $subscriber_id );Add Tag to a Subscriber
Apply a tag to a Subscriber.
$tag_id = '99999'; // This tag must be valid for your ConvertKit account.
$api->add_tag(tag_id, [
'email' => '[email protected]'
]);