Skip to main content
New to Corsair? See API access, authentication, and error handling.

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
Input Send exactly one of tag_id or tag_ids. A tag change can start or stop the automations attached to that tag. Output

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
Input Output

create

customers.create Create a contact. Email and lead score are the required pair; a score sent here replaces rather than adds Risk: write
Input Simplero requires both email and lead_score on a contact, so a create must send a score. Sending it replaces the stored score; use customers.adjustLeadScore to add to it instead. Output

get

customers.get Read one contact: their name, email, phone, locale, consent flags, lead score and lifetime value Risk: read
Input Output

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
Input Page by number with per_page up to 100, or pass pagination.next_after as after. With after, total and total_pages are null because counting is skipped. Output

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
Input Output

update

customers.update Change part of a contact. Only the fields sent change, so an omitted field keeps its stored value Risk: write
Input PATCH changes only the fields sent. An omitted field keeps its stored value. Output

Lists

create

lists.create Create an email list. Name and internal name are both required by Simplero Risk: write
Input Name and internal_name are both required by Simplero. Output

get

lists.get Read one list with its sender, confirmation settings and labels Risk: read
Input Output

list

lists.list List the email lists on the account with their names and handles Risk: read
Input Output

update

lists.update Change part of a list, such as its name, sender or whether signups need confirmation Risk: write
Input Output

Products

create

products.create Create a product. Name and internal name are both required by Simplero Risk: write
Input Name and internal_name are both required by Simplero. Output

get

products.get Read one product with its descriptions, listing type and product type Risk: read
Input Output

list

products.list List the products on the account, filtered by name, listing type or whether they recur Risk: read
Input Output

update

products.update Change part of a product, such as its name, summary or listing type Risk: write
Input Output

Purchases

get

purchases.get Read one purchase with its state, amounts, buyer details and dates Risk: read
Input Output

list

purchases.list List purchases with filters for state, customer, product, price and the purchase, cancel and refund dates Risk: read
Input Output

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
Input Buyer details and marketing preferences only. Refunds, cancellations, captures and price changes are separate Simplero actions and are not wrapped. Output

Subscriptions

get

subscriptions.get Read one subscription with whether it is active and confirmed, and when it was unsubscribed or suspended Risk: read
Input Output

list

subscriptions.list List list subscriptions with filters for state, list, tag, email and the unsubscribe date Risk: read
Input Output

resubscribe

subscriptions.resubscribe Put an unsubscribed contact back on a list, so they receive its mailings again Risk: write
Input Output

unsubscribe

subscriptions.unsubscribe Unsubscribe a contact from a list; they stop receiving its mailings. Resubscribe puts them back Risk: write
Input Output

update

subscriptions.update Change a subscription’s tracking data. Whether a contact is subscribed changes through unsubscribe or resubscribe, not this body Risk: write
Input Tracking data only. Whether a contact is subscribed changes through unsubscribe or resubscribe, not this body. Output

Tags

create

tags.create Create a tag, which contacts can then be tagged with Risk: write
Input Output

get

tags.get Read one tag with its colour, owner and how many contacts carry it Risk: read
Input Output

list

tags.list List the tags on the account, optionally only those one owner created Risk: read
Input Output

update

tags.update Change part of a tag, such as its name, description or colour Risk: write
Input Output