Convertkit Api

The Best Strategy To Use For Convertkit Api

The Best Strategy To Use For Convertkit Api

Calls for Convert Kit API v 3 are relative to the url v 3 remains in active development. Sweet! You’re developing an integration with Convert Kit. We’re thrilled that you want to add-on to our platform. However prior to you dive in and start slinging code, let’s talk about the finest method to integrate with Convert Set.

Let’s gone through a couple of examples: Email Capture. If your product is mostly for recording brand-new subscribers then you must integrate with kinds in Convert Package. So in Optin Monster when a subscriber opts-in they are subscriber to a kind in Convert Set. E-Commerce. The most essential thing for e-commerce clients is the ability to include a tag when a purchase is made.

Complete Combination. If you desire a more complete combination with Convert Set you can include assistance for forms, courses, and tags. If you aren’t sure how finest to structure your integration, just reach out to our team. We’ll enjoy to help you create it. If you’re working with a business that’s constructing a big combination with Convert Kit, please Using a combination key will allow your combination to access specific features of our API, and we’ll be able to deal with you to set custom rate restricting.

The Buzz on Convertkit ApiA Biased View of Convertkit Api

You can find your API Key in the Convert Kit Account page. Some API calls require the api_secret criterion. All calls that require api_key likewise work with api_secret, there’s no requirement to utilize both. This crucial grants access to delicate information and actions on your subscribers. You need to treat it as your password and do not use it in any client-side code (generally that indicates Java Script).

The Ultimate Guide To Convertkit ApiSome Known Details About Convertkit Api

Excitement About Convertkit Api

If there’s some mistake, the API will return an HTTP reaction in the 400 or 500 range and a reaction body indicating what the mistake was. For example: “error”: “Authorization Failed”, “message”: “API Key not present” with a 401 mistake. When you develop or upgrade a field, you may get an HTTP 422 if any fields include bad information or required fields are missing.

If your request rate surpasses our limitations, you will receive a 429 reaction, which your code must with dignity handle. We advise spacing out your demands and carrying out an rapid backoff to keep within the limitation. If the server is overwhelmed or you encounter a bug, you will get a 500 mistake.

Example Demand curl class=” o” >= Example action “name”:” Acme Corp.”, “primary_email_address”:” [email protected]” GET/ v 3/account api_secret – Your account API key. Example Demand curl class=” o” >= Example Action “kinds”: [“id”: 1, “name”: “A Type”, “created_at”: “2016-02-28T 08:07:00 Z”, “type”: “embed”, “url”:” class=” p” >, “embed_js”:” class=” p” >, “embed_url”:” class=” p” >, “title”: “Join the newsletter”, “description”: “Type description text.”, “sign_up_button_text”: “Subscribe”, “success_message”: “Success! Now check your email to verify your membership.”, “id”: 2, “name”: “A Landing Page”, “created_at”: “2016-02-28T 08:07:00 Z”, “type”: “hosted”, “url”:” class=” p” >, “embed_js”:” class=” p” >, “embed_url”:” class=” p” >, “title”: “Join the newsletter”, “description”: “”, “sign_up_button_text”: “Subscribe”, “success_message”: “Success! Now check your email to verify your subscription.”] Get a list of all the types for your account.

Not known Details About Convertkit Api The 6-Second Trick For Convertkit Api

Example Request curl -X POST class=” se” > \ -H “Content-Type: application/json; charset= utf-8” \ -d’ \ “api_key”: “”, \ “e-mail”: “[email protected]” \’ # Include a tag throughout subscribing curl -X POST class=” se” > \ -H “Content-Type: application/json; charset= utf-8” \ -d’ \ “api_key”: “”, \ “email”: “[email protected]”, \ “tags”: [1234, 5678] \’ Example Reaction “subscription”: “id”: 1, “state”: “non-active”, “created_at”: “2016-02-28T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “form”, “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” Subscribe an e-mail address to one of your forms.

3 Simple Techniques For Convertkit Api

email – Customer e-mail address. first_name – Subscriber very first name. fields – Object of key/value pairs for customized fields (the customized field need to exist before you can use it here). tags – Variety of tag ids to sign up for. courses – Variety of sequence ids to subscribe to. You need to include the subscriber to the sequence straight.

You ought to include the customer to each form individually. name – Subscriber given name. You should choose using first_name noted above. Example Request curl class=” o” >= Example response “total_subscriptions”: 2, “page”: 1, “total_pages”: 1, “memberships”: [“id”: 1, “state”: “active”, “created_at”: “2016-02-28T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “form”, “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”,, “id”: 2, “state”: “active”, “created_at”: “2016-02-27T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “form”, “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 memberships to a kind consisting of customer information.

asc is the default order. subscriber_state – active or cancelled: get only active customers or cancelled subscribers NOTE: Sequences were previously referred to as Courses API v 3 keeps the previous naming conventions, however will accept requests to sequences as the endpoint also. Example demand curl class=” o” >= Example response “courses”: [“id”: 1, “name”: “My First Series”, “created_at”: “2016-02-28T 08:07:00 Z”, “id”: 2, “name”: “My 2nd Sequence”, “created_at”: “2016-02-28T 08:07:00 Z”] Returns a list of sequences for the account.

Example request curl -X POST class=” se” > \ -H “Content-Type: application/json; charset= utf-8” \ -d Example action “membership”: “id”: 2, “state”: “non-active”, “created_at”: “2016-02-28T 08:07:00 Z”, “source”: null, “referrer”: null, “subscribable_id”: 1, “subscribable_type”: “course”, “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” Subscribe an email address to one of your sequences.

Rumored Buzz on Convertkit ApiNot known Facts About Convertkit Api

Convertkit Api for Beginners

e-mail – Subscriber email address. first_name – Subscriber given name. fields – Item of key/value sets for customized fields (the customized field should exist before you can utilize it here). tags – Variety of tag ids to subscribe to. courses – Selection of series ids to register for. You need to include the subscriber to each course individually.

  • new API integration
  • required parameter
  • API Secret section
  • Subscriber Field
  • request curl
  • required parameter
  • Subscriber Field
  • Company Name
  • required parameter
  • request curl
  • Account Settings
  • Optional parameters
  • Subscriber Field
  • request curl
  • required parameter
  • request curl
  • required parameter
  • Subscriber Field
  • custom field
  • required parameter
  • request curl
  • account info page
  • required parameter
  • API Secret Key
  • Subscriber Field
  • request curl
  • required parameter
  • trigger name
  • request curl
  • required parameter
  • custom field
  • Subscriber Field
  • request curl
  • required parameter
  • required parameter
  • Subscriber Field
  • Optional parameters
  • Email Links
  • request curl
  • webhook automation
  • required parameter
  • Email Links
  • Optional parameters
  • copy and paste
  • registration automations
  • Click Integrations
  • registration automations
  • contact field
  • Subscriber Field
  • initiator value String
  • email address param
  • unique identifiers
  • subscriber data
  • Callback Endpoint URL
  • configured tags
  • request curl
  • email service provider
  • required parameter
  • Email Capture
  • third party integrations
  • tags endpoints
  • Event Tracking
  • WordPress Plugin
  • access token
  • sensitive data
  • required parameter
  • Email Links
  • official integration
  • Email Integrations
  • subscriber data
  • Filter subscribers
  • Endpoint Update field Example
  • key/value pairs
  • Company Name
  • request curl
  • Optional parameters
  • official integration
  • field information
  • custom field
  • required parameter
  • email marketing tool
  • Interact app builder
  • key/value pairs
  • Optional parameters
  • required parameter
  • contact field
  • required parameter
  • custom field
  • required parameter
  • Optional parameters
  • key/value pairs
  • client-side code
  • subscriber data
  • required parameter
  • contact field
  • custom field
  • Filter subscribers
  • required parameter
  • -d api secret
  • required parameter
  • subscriber data
  • Optional parameters
  • required parameter
  • Optional parameters
  • subscriber data
  • custom field
  • required parameter
  • Optional parameters
  • subscriber data
  • webhook automation
  • required parameter
  • Optional parameters
  • custom field
  • Filter subscribers
  • required parameter
  • Optional parameters
  • subscriber data
  • Filter subscribers
  • API credential fields
  • required parameter