Convertkit Api

The Ultimate Beginners Guide to Convertkit Api

The Ultimate Beginners Guide to Convertkit Api

POST/ v 3/automations/hooks api_secret – Your api secret key. target_url – The URL that will receive subscriber data when the occasion is set off. event – JSON item that includes the trigger name and additional info when needed. For instance: “name”: “subscriber.subscriber _ trigger” “name”: “purchase.purchase _ create” “name”: “subscriber.tag _ include”, “tag_id”: 4 These are the available occasion types: “subscriber.subscriber _ activate” “subscriber.subscriber _ unsubscribe” “subscriber.form _ subscribe”, needed specification: form_id [Integer] “subscriber.course _ subscribe”, needed specification: course_id [Integer] “subscriber.course _ total”, required parameter: course_id [Integer] “subscriber.link _ click”, required criterion: initiator_value [String] as a link URL “subscriber.product _ purchase”, needed parameter: product_id [Integer] “subscriber.tag _ include”, required criterion: tag_id [Integer] “subscriber.tag _ eliminate”, needed parameter: tag_id [Integer] “purchase.purchase _ create” Example demand curl -X ERASE -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”‘ Example reaction “success”: true Deletes a webhook.

A customized field allows you to collect subscriber information beyond the basic fields of given name and email address. An example would be a customized field called last name so you can get the complete names of your customers. You create a custom-made field, and then you have the ability to utilize that in your kinds or with the API (see the Subscribers endpoint for adding custom field values to a subscriber.) Note that you need to produce a custom-made field prior to you can utilize it with the subscribe methods on the types, sequences, and tags endpoints.

The Ultimate Guide To Convertkit ApiConvertkit Api Things To Know Before You Buy

GET/ v 3/custom _ fields api_key – Your account API key. Example demand Single label curl -X POST class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: “Occupation”‘ Several labels curl -X POST class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: [” Profession”, “Area”]’ Example reaction: Single custom field “id”: 1, “name”: “ck_field_1_occupation”, “key”: “occupation”, “label”: “Occupation” Example response: Several custom-made fields [“id”: 1, “name”: “ck_field_1_occupation”, “essential”: “occupation”, “label”: “Occupation”, “id”: 2, “name”: “ck_field_2_occupation”, “key”: “place”, “label”: “Area”] Produce a customized field for your account.

Whitespace will be gotten rid of from the beginning and the end of your label. Additionally, an essential field and a name field will be generated for you. The secret is an ASCII-only, lowercased, underscored representation of your label. This secret must be distinct to your account. Keys are used in personalization tags in sequences and broadcasts.

Some Known Questions About Convertkit Api.Not known Details About Convertkit Api

What Does Convertkit Api Do?

They are made up of a combination of ID and the secret of the custom field prefixed with “ck_field”. POST/ v 3/custom _ fields api_secret – Your api secret key. label – The label( s) of the custom-made field. Example request curl -X PUT class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: “Occupation”‘ Example action No content will be returned.

Getting The Convertkit Api To WorkThe Best Strategy To Use For Convertkit Api

Keep in mind that the key and the name do not change even when the label is upgraded. PUT/ v 3/custom _ fields/ # your custom-made field ID api_secret – Your api secret key. id – The ID of your custom field. label – The label of the customized field. Example demand curl -X DELETE class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”‘ Example action No content will be returned.

Keep in mind that this will eliminate all data in this field from your subscribers. DELETE/ v 3/custom _ fields/ # your custom field ID api_secret – Your api secret key. id – The ID of your custom-made field. Example demand curl class=” o” >= Example action “total_purchases”: 2, “page”: 1, “total_pages”: 1, “purchases”: [“id”: 3, “transaction_id”: “123-abcd-456-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “JPY”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount rate”: 3.0, “tax”: 2.0, “total”: 21.0, “products”: [“unit_price”: 5.0, “amount”: 2, “sku”: “7890-ijkl”, “name”: “Floppy Disk (512k)”, “unit_price”: 10.0, “amount”: 1, “sku”:” mnop-1234″, “name”:” Telephone Cord (information)”], “id”: 4, “transaction_id”: “123-abcd-457-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “USD”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount rate”: 3.0, “tax”: 2.0, “overall”: 21.0, “items”: [“unit_price”: 5.0, “quantity”: 2, “sku”: “7890-ijkl”, “name”: “Floppy Disk (512k)”, “unit_price”: 10.0, “quantity”: 1, “sku”: “mnop-1234”, “name”: “Telephone Cable (information)”]] Failure response.

The Best Strategy To Use For Convertkit ApiWhat Does Convertkit Api Mean?

page – The page of outcomes being requested. Default value is 1. Each page of results will consist of up to 50 purchases. Example demand curl class=” o” >= Example action “id”: 8, “transaction_id”: “123-abcd-456-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “JPY”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount rate”: 3.0, “tax”: 2.0, “total”: 21.0, “products”: [“unit_price”: 5.0, “amount”: 2, “sku”: “7890-ijkl”, “name”: “Floppy Disk (512k)”, “unit_price”: 10.0, “amount”: 1, “sku”: “mnop-1234”, “name”: “Telephone Cable (information)”] Failure reaction.

Convertkit Api - An OverviewConvertkit Api Things To Know Before You Get This

The Single Strategy To Use For Convertkit Api

purchase_id – A purchase ID Example demand curl -X POST \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “purchase”: “transaction_id”: “123-abcd-456-efgh”, “email_address”: “[email protected]”, “first_name”: “John”, “currency”: “jpy”, “transaction_time”: “2018-03-17 11:28:04”, “subtotal”: 20.00, “tax”: 2.00, “shipping”: 2.00, “discount”: 3.00, “overall”: 21.00, “status”: “paid”, “products”: [“pid”: 9999, “lid”: 7777, “name”: “Floppy Disk (512k)”, “sku”: “7890-ijkl”, “unit_price”: 5.00, “amount”: 2, “pid”: 5555, “lid”: 7778, “name”: “Telephone Cord (information)”, “sku”: “mnop-1234”, “unit_price”: 10.00, “quantity”: 1]’ Example reaction: “id”: 8, “transaction_id”: “123-abcd-456-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “JPY”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “discount”: 3.0, “tax”: 2.0, “shipping”: 2.00, “overall”: 21.0, “products”: [“unit_price”: 5.0, “amount”: 2, “sku”: “7890-ijkl”, “name”: “Floppy (512k)”, “unit_price”: 10.0, “amount”: 1, “sku”: “mnop-1234”, “name”: “Telephone Cable (information)”] Failure action: HTTP/1.1 400 Bad Request “error”: “Your demand is missing specifications”, “message”: “transaction_id can’t be blank, Sku can’t be blank for product: Floppy (512k)” POST/ v 3/purchases api_secret – Your api secret key.

Each product offered in the ‘products’ variety should have an unique pid. Versions of the exact same product must have the exact same pid. products.lid – Each item must have a lid that is unique to the product for this purchase. If you have ‘line products’, cover is where you would put your identifier for each line product.

  • 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