Customers
addTag
customers.addTag
Add one tag or a list of tags to a contact, which can start the automations that tag is attached to
Risk: write
data full type
data full type
adjustLeadScore
customers.adjustLeadScore
Add to a contact’s lead score and record the change in their history; customers.update replaces the score instead
Risk: write
data full type
data full type
create
customers.create
Create a contact. Email and lead score are the required pair; a score sent here replaces rather than adds
Risk: write
data full type
data full type
get
customers.get
Read one contact: their name, email, phone, locale, consent flags, lead score and lifetime value
Risk: read
data full type
data full type
list
customers.list
List contacts with filters for name, email, tag, segment, list, product and stage; page by number or continue with after
Risk: read
data full type
data full type
pagination full type
pagination full type
removeTag
customers.removeTag
Remove one tag or a list of tags from a contact, which can stop the automations that tag is attached to
Risk: write
data full type
data full type
update
customers.update
Change part of a contact. Only the fields sent change, so an omitted field keeps its stored value
Risk: write
data full type
data full type
Lists
create
lists.create
Create an email list. Name and internal name are both required by Simplero
Risk: write
data full type
data full type
get
lists.get
Read one list with its sender, confirmation settings and labels
Risk: read
data full type
data full type
list
lists.list
List the email lists on the account with their names and handles
Risk: read
data full type
data full type
pagination full type
pagination full type
update
lists.update
Change part of a list, such as its name, sender or whether signups need confirmation
Risk: write
data full type
data full type
Products
create
products.create
Create a product. Name and internal name are both required by Simplero
Risk: write
data full type
data full type
get
products.get
Read one product with its descriptions, listing type and product type
Risk: read
data full type
data full type
list
products.list
List the products on the account, filtered by name, listing type or whether they recur
Risk: read
data full type
data full type
pagination full type
pagination full type
update
products.update
Change part of a product, such as its name, summary or listing type
Risk: write
data full type
data full type
Purchases
get
purchases.get
Read one purchase with its state, amounts, buyer details and dates
Risk: read
data full type
data full type
list
purchases.list
List purchases with filters for state, customer, product, price and the purchase, cancel and refund dates
Risk: read
data full type
data full type
pagination full type
pagination full type
update
purchases.update
Change a purchase’s buyer details and marketing preferences. Money movements (refund, cancel, capture, change price) are separate actions and are not wrapped
Risk: write
data full type
data full type
Subscriptions
get
subscriptions.get
Read one subscription with whether it is active and confirmed, and when it was unsubscribed or suspended
Risk: read
data full type
data full type
list
subscriptions.list
List list subscriptions with filters for state, list, tag, email and the unsubscribe date
Risk: read
data full type
data full type
pagination full type
pagination full type
resubscribe
subscriptions.resubscribe
Put an unsubscribed contact back on a list, so they receive its mailings again
Risk: write
data full type
data full type
unsubscribe
subscriptions.unsubscribe
Unsubscribe a contact from a list; they stop receiving its mailings. Resubscribe puts them back
Risk: write
data full type
data full type
update
subscriptions.update
Change a subscription’s tracking data. Whether a contact is subscribed changes through unsubscribe or resubscribe, not this body
Risk: write
data full type
data full type
Tags
create
tags.create
Create a tag, which contacts can then be tagged with
Risk: write
data full type
data full type
get
tags.get
Read one tag with its colour, owner and how many contacts carry it
Risk: read
data full type
data full type
list
tags.list
List the tags on the account, optionally only those one owner created
Risk: read
data full type
data full type
pagination full type
pagination full type
update
tags.update
Change part of a tag, such as its name, description or colour
Risk: write
data full type
data full type