Convertkit

Convertkit module for RobinPath.

Package: @robinpath/convertkit | Category: Email Marketing | Type: Integration

Authentication

convertkit.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the convertkit module when you need to:

• listSubscribers -- Use convertkit.listSubscribers to perform this operation
• getSubscriber -- Use convertkit.getSubscriber to perform this operation
• createSubscriber -- Use convertkit.createSubscriber to perform this operation
• updateSubscriber -- Use convertkit.updateSubscriber to perform this operation
• unsubscribeSubscriber -- Use convertkit.unsubscribeSubscriber to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure convertkit credentials.	object
listSubscribers	listSubscribers	object
getSubscriber	getSubscriber	object
createSubscriber	createSubscriber	object
updateSubscriber	updateSubscriber	object
unsubscribeSubscriber	unsubscribeSubscriber	object
listTags	listTags	object
createTag	createTag	object
tagSubscriber	tagSubscriber	object
removeTagFromSubscriber	removeTagFromSubscriber	object
listSequences	listSequences	object
addSubscriberToSequence	addSubscriberToSequence	object
listForms	listForms	object
listBroadcasts	listBroadcasts	object
createBroadcast	createBroadcast	object
getAccount	getAccount	object
listPurchases	listPurchases	object

Functions

setCredentials

Configure convertkit credentials.

Module: convertkit | Returns: object -- API response.

convertkit.setCredentials

Parameter	Type	Required	Description
apiSecret	string	Yes	apiSecret

---

listSubscribers

listSubscribers

Module: convertkit | Returns: object -- API response.

convertkit.listSubscribers

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSubscriber

getSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.getSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createSubscriber

createSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.createSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateSubscriber

updateSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.updateSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

unsubscribeSubscriber

unsubscribeSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.unsubscribeSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listTags

listTags

Module: convertkit | Returns: object -- API response.

convertkit.listTags

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createTag

createTag

Module: convertkit | Returns: object -- API response.

convertkit.createTag

Parameter	Type	Required	Description
input	string	No	Input parameter

---

tagSubscriber

tagSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.tagSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

removeTagFromSubscriber

removeTagFromSubscriber

Module: convertkit | Returns: object -- API response.

convertkit.removeTagFromSubscriber

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listSequences

listSequences

Module: convertkit | Returns: object -- API response.

convertkit.listSequences

Parameter	Type	Required	Description
input	string	No	Input parameter

---

addSubscriberToSequence

addSubscriberToSequence

Module: convertkit | Returns: object -- API response.

convertkit.addSubscriberToSequence

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listForms

listForms

Module: convertkit | Returns: object -- API response.

convertkit.listForms

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listBroadcasts

listBroadcasts

Module: convertkit | Returns: object -- API response.

convertkit.listBroadcasts

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createBroadcast

createBroadcast

Module: convertkit | Returns: object -- API response.

convertkit.createBroadcast

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getAccount

getAccount

Module: convertkit | Returns: object -- API response.

convertkit.getAccount

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPurchases

listPurchases

Module: convertkit | Returns: object -- API response.

convertkit.listPurchases

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Convertkit API error (${res.status}): ${t}	Check the error message for details
convertkit.setCredentials requires apiSecret.	Check the error message for details
convertkit.updateSubscriber requires an ID.	Check the error message for details
convertkit.unsubscribeSubscriber requires an ID.	Check the error message for details
convertkit.removeTagFromSubscriber requires an ID.	Check the error message for details
Convertkit: "..." not configured. Call convertkit.setCredentials first.	Check the error message for details

@desc "List subscribers and validate result"
do
  set $result as convertkit.listSubscribers
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Subscribers

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "List subscribers and iterate results"
do
  set $result as convertkit.listSubscribers
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createSubscriber

Create a new resource and capture the result.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "Create subscriber"
do
  set $result as convertkit.createSubscriber
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "Create subscriber and update subscriber"
do
  set $created as convertkit.createSubscriber
  # Update the created item
  convertkit.updateSubscriber
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "List subscribers and create subscriber"
do
  set $existing as convertkit.listSubscribers
  if $existing == null
    convertkit.createSubscriber
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Convertkit workflow

Chain multiple convertkit operations together.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "List subscribers, get subscriber, and more"
do
  set $r_listSubscribers as convertkit.listSubscribers
  set $r_getSubscriber as convertkit.getSubscriber
  set $r_createSubscriber as convertkit.createSubscriber
  print "All operations complete"
enddo

6. Safe listSubscribers with validation

Check results before proceeding.

@desc "Setup authentication"
do
  convertkit.setCredentials $token
enddo

@desc "List subscribers and validate result"
do
  set $result as convertkit.listSubscribers
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• activecampaign -- ActiveCampaign module for complementary functionality
• brevo -- Brevo module for complementary functionality
• mailchimp -- Mailchimp module for complementary functionality
• sendgrid -- SendGrid module for complementary functionality
• lemlist -- Lemlist module for complementary functionality