| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://simplero.com/api/v1 | link | — | — | — |
Actions (25)
Contacts · 7
- Add tag to contactPOST /customers/add_tag.json
Add a tag to the contact identified by email.
documented - Course completionsPOST /customers/course_completions.json
Provide a broad view of a contact's course progress across sites and courses.
documented - Create or update contactPOST /customers.json
Create a new contact or update an existing contact by email.
documented - Find contact by emailPOST /customers/find.json
Find a contact by email address.
documented - Get contact by IDGET /customers/{id}.json
Retrieve a contact by its internal ID.
documented - Remove tag from contactPOST /customers/remove_tag.json
Remove a tag from the contact identified by email.
documented - Update contact credentialsPOST /customers/update_credentials.json
Update a contact's login credentials.
documented
Administrators · 6
- Create or update administratorPOST /administratorships.json
Create a new administrator or update an existing administrator.
documented - Find administrator by emailPOST /administratorship/find.json
Find an administrator by email.
documented - Get admin rolesGET /admin_roles.json
Return all available administrator roles.
documented - Get administrator by IDGET /administratorships/{id}.json
Retrieve an administrator by internal ID.
documented - Get administratorsGET /administratorships.json
Return all administrators for the account.
documented - Remove administratorDELETE /administratorships/{id}.json
Delete an administrator by ID.
documented
Lists · 5
- Bulk subscribe to listPOST /lists/{list_id}/bulk_subscribe.json
Subscribe multiple contacts to a list in a single request; returns a token for status.
documented - Find subscription by emailPOST /lists/{list_id}/subscriptions/find.json
Find subscriptions for a given email on a specific list.
documented - Get listsGET /lists.json
Return all lists in the account.
documented - Subscribe to listPOST /lists/{list_id}/subscribe.json
Subscribe a contact to a specific list by ID.
documented - Unsubscribe from listPOST /lists/{list_id}/unsubscribe.json
Unsubscribe a contact from a list by ID.
documented
Products · 4
- Find purchase by ID or tokenPOST /products/{id}/purchases/find.json
Find a purchase by ID or token for a product (ID or token may be provided via URL query or POST body).
documented - Find purchase by emailPOST /products/{id}/purchases/find.json
Find purchases for a product by email.
documented - Get product by IDGET /products/{id}.json
Retrieve a product by its ID.
documented - Get productsGET /products.json
List all account's products.
documented