Convertkit Api

An Unbiased View of Convertkit Api

An Unbiased View of Convertkit Api

asc is the default order. subscriber_state?-? active?or?? cancelled: get only active subscribers or cancelled subscribers Example demand curl class=” o” >= Example response “tags”: [“id”: 1, “name”: “House Stark”, “created_at”: “2016-02-28T 08:07:00 Z”, “id”: 2, “name”: “Home Lannister”, “created_at”: “2016-02-28T 08:07:00 Z”] Returns a list of tags for the account.

Example demand Single tag curl -X POST -H ‘Content-Type: application/json’ \ -d’ “api_key”: “”, \ “tag”: \ “name”: “Example Tag” \’ Numerous tags curl -X POST -H ‘Content-Type: application/json’ \ -d’ “api_key”: “”, \ “tag”: [\ “name”: “Example Tag” \, \ “name”: “Example Tag 2” \]’ Example action “account_id”: 1, “created_at”: “2017-04-12T 11:10:32 Z”, “deleted_at”: null, “id”: 1, “name”: “Example Tag”, “state”: “offered”, “updated_at”: “2017-04-12T 11:10:32 Z” A request to develop multiple tags will receive a JSON array with the very same type of things: [“account_id”: 1, “created_at”: “2017-04-12T 11:10:32 Z”, “deleted_at”: null, “id”: 1, “name”: “Example Tag”, “state”: “offered”, “updated_at”: “2017-04-12T 11:10:32 Z”, “account_id”: 1, “created_at”: “2017-04-12T 11:11:566 Z”, “deleted_at”: null, “id”: 1, “name”: “Example Tag 2”, “state”: “readily available”, “updated_at”: “2017-04-12T 11:11:566 Z”] POST/ v 3/tags api_key – Your account API secret.

Subscribe an email address to a tag to have that tag used to the customer with that e-mail address. POST/ v 3/tags/ # tag_id/ subscribe api_key – Your account API key. email – Customer email address. first_name – Subscriber given name. fields – Object of key/value sets for custom fields (the custom field must exist before you can utilize it here).

courses – Selection of sequence ids to subscribe to. You need to include the subscriber to the series directly. types – Selection of kind ids to sign up for. You need to include the customer to the form directly. name – Customer first name. You need to choose using first_name listed above. Example demand curl -X ERASE class=” o” >= Example reaction “id”: 1, “name”: “Home Stark”, “created_at”: “2016-02-28T 08:07:00 Z” DELETE/ v 3/subscribers/ # subscriber_id/ tags/ # tag_id api_secret – Your api secret key.

Some Known Incorrect Statements About Convertkit Api

e-mail – Customer email address. Example demand curl class=” o” >= Example response “total_subscriptions”: 2, “page”: 1, “total_pages”: 1, “subscriptions”: [“id”: 1, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “tag”, “subscriber”: “id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow”,, “id”: 2, “state”: “active”, “created_at”: “2016-02-27T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “tag”, “customer”: “id”: 2, “first_name”: “Arya”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-27T 08:07:00 Z”, “fields”: “last_name”: “Stark”,] List subscriptions to a tag consisting of subscriber information.

Getting My Convertkit Api To WorkThe Definitive Guide for Convertkit Api

asc is the default order. subscriber_state – active or cancelled: get just active customers or cancelled subscribers Example request curl class=” o” >=& from= 2016-02-01 & to= 2015-02-28 Example reaction “total_subscribers”: 3, “page”: 1, “total_pages”: 1, “customers”: [“id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow”, “id”: 2, “first_name”: “Arya”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Stark”] Returns a list of your subscribers.

Browse customers by e-mail address by providing the email_address param. GET/ v 3/subscribers api_secret – Your api secret key. page – Page for paginated results. from – Filter customers included on or after this date (format yyyy-mm-dd). to – Filter subscribers included on or prior to this date (format yyyy-mm-dd). updated_from – Filter customers who have been upgraded after this date (format yyyy-mm-dd) updated_to – Filter customers who have actually been upgraded before this date (format yyyy-mm-dd) sort_order – Sort order for results (asc or desc).

Convertkit Api for Dummies3 Simple Techniques For Convertkit Api

email_address – Browse subscribers by email address. Example demand curl class=” o” >= Example action “customer”: “id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow” Returns information for a single customer GET/ v 3/subscribers/ # subscriber_id api_secret – Your api secret key. Example demand curl -X PUT class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, \ “first_name”: “Jon”, \ “email_address”: “[email protected]”, \ “fields”: \ “last_name”: “Snow” \’ Example reaction: Approximately 10 custom-made fields, status 200 “customer”: “id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow” Example action: 11 to 125 custom-made fields, status 202 “customer”: “id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow” Updates the info for a single customer.

More About Convertkit ApiSome Known Incorrect Statements About Convertkit Api
The Ultimate Guide To Convertkit ApiThe Buzz on Convertkit Api

The Greatest Guide To Convertkit Api

first_name – Upgraded very first name for the subscriber. email_address – Upgraded e-mail address for the customer. fields – Updated customized fields for your customer as things of key/value sets (the customized field must exist prior to you can use it here). KEEP IN MIND: The API response returned when updating custom fields is dependent on the number of custom-made fields in the demand, as shown by the examples at right.

Demands that surpass this limit will return an action of 400. Example demand curl -x PUT -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, \ “e-mail”: “[email protected]”‘ Example action “subscriber”: “id”: 1, “first_name”: “Jon”, “email_address”: “[email protected]”, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “fields”: “last_name”: “Snow” Unsubscribe an email address from all your kinds and series.

Our Convertkit Api Diaries

email – Subscriber email address. Example request curl class=” o” >= Example reaction “tags”: [“id”: 1, “name”: “Email Newsletter”, “created_at”: “2016-06-09T 17:54:22 Z”] Lists all the tags for a subscriber. GET/ v 3/subscribers/ # subscriber_id/ tags api_key – Your account API secret. A Broadcast is a one-time email blast that can either be sent out right now or scheduled for a future time and date.

GET/ v 3/broadcasts api_secret – Your API secret key. Get the statistics (recipient count, open rate, click rate, unsubscribe count, overall clicks, status, send out development) from a specific broadcast. GET/ v 3/broadcasts/ # broadcast_id/ statistics Example Demand curl class=” o” >= Example Action “broadcast”: [“id”:1, “statistics”: “recipients”: 82, “open_rate”: 60.97560975609756, “click_rate”: 23.170731707317074, “unsubscribes”: 9, “total_clicks”: 15, “show_total_clicks”: false, “status”: “completed”, “progress”: 100.0] api_secret – Your account API secret key.