API Info
From Enterprise Help
Service Endpoint
|
Base URL |
|
|
Endpoints |
/Sites /Lists /Stores /Members /ProfileFields |
|
HTTP Method |
GET to query data
For Lists and Members endpoints, these methods are also available: POST to insert PATCH/MERGE to update DELETE to delete |
|
Header |
Authorization: Bearer [ACCESS_TOKEN] Note: Before making each request, check that the access token is still valid, otherwise obtain a new access token using the user’s refresh token. |
Entities
Create, Read, Update, and Delete functionality is available for the following entities:
- & Mailings Campaign
- Content Variables GlobalVariable
- List
- Mailing
- MailingSegment (maps Mailings to their corresponding Segments)
- Member
- MemberTag (maps Members to their corresponding Tags)
- Subscription (maps Members to the Lists to which they’re currently subscribed)
- Tag
- TagGroup
Read-only functionality is available for the following entities:
- ApiClientRequest (categorizes and aggregates counts of requests by API clients; useful for troubleshooting purposes)
- Bounce
- Brand
- Category
- Click (inserted when a Member clicks on any tracked hyperlink in an email message)
- Group
- GroupStore
- Hyperlink (automatically tracked by the Fishbowl system after being automatically discovered within the HTML or text content of a Mailing)
- MailOpen (inserted when a Member opens an email message and chooses to display images)
- Message (represents a single email message to a single Member)
- Fields ProfileField
- Segment
- Site (each Site is a fully autonomous unit with the Fishbowl system)
- Store
- SubsciptionEvent (inserted each time a Member subscribe to or unsubscribes from a single List)
- Template
- Theme
- Messaging Trigger
- Statistics UserAgent (categorizes device/application/OS data whenever a MailOpen or Click event occurs)
