Download the PHP package firewards/convertkit-php-api without Composer
On this page you can find all versions of the php package firewards/convertkit-php-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download firewards/convertkit-php-api
More information about firewards/convertkit-php-api
Files in firewards/convertkit-php-api
Package convertkit-php-api
Short Description Simple access interface to ConvertKit's web API.
License MIT
Informations about the package convertkit-php-api
ConvertKit PHP
Unofficial ConvertKit PHP API for v3.
This package makes it simple to access ConvertKit's web API. Checkout https://developers.convertkit.com for more information on ConvertKit's API.
Install
Via Composer
Requirements
The following versions of PHP are supported.
- PHP 5.6
- PHP 7.0
- PHP 7.1
- PHP 7.2
- PHP 7.3
API Key
All API calls require an API Key. You can find your API Key in the ConvertKit Account page.
API Secret
Some API calls require an API Secret. All calls that require the api key will also work with the api secret, there's no need to use both. This key grants access to sensitive data and actions on your subscribers.
Usage
Start by using ConvertKit API and creating an instance with your ConvertKit API key
Examples
Get all Subscribers
Get all subscribers using pagination.
Get all Custom Fields
Create a Custom Field
Update subscriber
Updates a subscriber and adds info to a custom field 'last_name'.
Get Tags
Retrieve all tags.
Add Subscriber to Tag
Adds a subscriber to a specific tag.
Subscribe to a form
Add a subscriber to a form. The $subscribed
response will be an object.
Get Subscriber ID
Get the ConvertKit Subscriber ID for a given email address.
Get Subscriber
Get subscriber data for a ConvertKit Subscriber.
Get Subscriber Tags
Get all tags applied to a Subscriber.
Add Tag to a Subscriber
Apply a tag to a Subscriber.
Rate limiting
Please note that ConvertKit is rate limiting requests by 120 requests per minute. If your request rate exceeds the limit, ConvertKit PHP Api will throw a RateLimitExcededException.
License
The MIT License (MIT). Please see License File for more information.
Sponsor
This package is sponsored by www.firewards.com, Firewards makes it easy to setup a referral and rewards program for your email list and newsletter.