UserRole
| API | Description |
|---|---|
| GET api/userroles |
Get all users' roles |
| GET api/userroles/{id} |
Get a user role by ID |
| GET api/userroles/GetAllRoles |
Get all roles |
| GET api/userroles/GetRolesForUser?userId={userId} |
Get all roles for user by user ID |
CustomerGroup
| API | Description |
|---|---|
| GET api/customergroups |
Get all customer groups |
| GET api/customergroups/{id} |
Get a customer group by ID |
| GET api/customergroups/GetByCustomerId?id={id} |
Get a customer group by customer ID |
| GET api/customergroups/GetByUserId?id={id} |
Get a customer group by user ID |
| POST api/customergroups |
Create a new customer group |
| PUT api/customergroups/{id} |
Update a customer group |
| DELETE api/customergroups/{id} |
Delete a customer group |
App
| API | Description |
|---|---|
| GET api/apps |
Get all apps |
| GET api/apps/{id} |
Get an app by ID |
| GET api/apps/{customerGroupId} |
Get an app by customer group ID |
| POST api/apps |
Create a new app |
| PUT api/apps/{id} |
Update an app |
| DELETE api/apps/{id} |
Delete an app |
| GET api/apps/{appId}/GetBubbleIcons |
No documentation available. |
Segment
| API | Description |
|---|---|
| GET api/segments |
Get all Segments |
| GET api/segments/GetByCustomerGroupId?id={id} |
Get all Segments by customer group |
File
| API | Description |
|---|---|
| POST api/upload/batch |
No documentation available. |
| POST api/upload |
Post Multipart form-data with files FormData["CustomerId"] CustomerId posted files will be saved under |
Auth
| API | Description |
|---|---|
| POST api/auth/login |
Login with email and password |
User
| API | Description |
|---|---|
| GET api/users?include[0]={include[0]}&include[1]={include[1]} |
Get all users |
| GET api/users/{id} |
Get a user by ID |
| POST api/users |
Create a user |
| PUT api/users/{id} |
Update a user |
| DELETE api/users/{id} |
Delete a user |
| PUT api/users/{id}/password |
Update user password |
| GET api/users/{id}/externalAppSettings |
Get user external app settings for pushing to devices |
Pinch
| API | Description |
|---|---|
| GET api/pinches |
Get all Pinches |
| GET api/pinches/{id} |
Get a Pinch by ID |
| GET api/pinches/search |
Search for pinches |
| GET api/pinches/GetByCustomerGroup?id={id} |
Get Pinch by Customer Group ID |
| POST api/pinches |
Create a new Pinch |
| PUT api/pinches/{pinchId}/general |
Update a Pinch's General Part |
| PUT api/pinches/{pinchId}/content |
Update a Pinch's content |
| PUT api/pinches/{pinchId}/notification |
Update a Pinch's notification settings |
| PUT api/pinches/{pinchId}/time |
Update a Pinch's timing settings |
| PUT api/pinches/{pinchId}/criteria |
Update a Pinch's criteria |
| PUT api/pinches/{pinchId}/messagesettings |
Update a Pinch's message center settings |
| GET api/pinches/{pinchId}/time |
Update a Pinch's timing settings |
| DELETE api/pinches/{id} |
Delete a pinch |
| PUT api/pinches/{pinchId}/triggerPush |
Trigger pushing a pinch to devices |
SegmentSelection
| API | Description |
|---|---|
| GET api/pinches/{id}/segments |
Get Segment Groups with Segments by Pinch |
| POST api/pinches/{id}/segments |
Create new Segment Group with Segments |
Report
| API | Description |
|---|---|
| GET api/reports/{customerGroupId} |
No documentation available. |
Template
| API | Description |
|---|---|
| GET api/templates/definition/{templateId} |
Get template definition by template id |
| GET api/templates/pinch/{pinchId} |
Get template content by pinch id |
| GET api/templates/draft/{draftId} |
Get template draft by draft id |
| GET api/templates/customergroup/{customerGroupId} |
Get templates list for customer group |
| GET api/templates/{id} |
Get template info |
| POST api/templates |
Create a new TemplateInfo |
| PUT api/templates/{id} |
Update a TemplateInfo |
| PUT api/templates/search |
No documentation available. |
| DELETE api/templates/{id} |
Delete a TemplateInfo |
| GET api/templates/{id}/templateoptions |
Get template children options |
ContentExternal
| API | Description |
|---|---|
| GET api/external/contents/v2/{contentId}?includeTree={includeTree}&languageBranch={languageBranch} |
No documentation available. |
| GET api/external/contents/{contentId}?includeTree={includeTree} |
No documentation available. |
| GET api/external/contents/v2/pinch/{pinchId}?languageBranch={languageBranch} |
No documentation available. |
| GET api/external/contents/pinch/{pinchId} |
No documentation available. |
Tag
| API | Description |
|---|---|
| GET api/customers/{id}/tags |
Get tags by Customer ID |
PinchPublish
| API | Description |
|---|---|
| PUT api/pinches/{pinchid}/publish |
Publish a pinch |
| PUT api/pinches/{publishid}/edit |
Edit a published pinch |
| PUT api/pinches/{publishid}/Deactivate |
Deactivate a published pinch |
| PUT api/pinches/{publishid}/Activate |
Activate deactivated pinch |
| GET api/pinches/{publishId}/versions |
No documentation available. |
TriggerSelection
| API | Description |
|---|---|
| GET api/pinches/{id}/triggers |
Get Trigger Groups with Triggers by Pinch |
| POST api/pinches/{id}/triggers |
Create new Trigger Group with Triggers |
Preset
| API | Description |
|---|---|
| GET api/presets |
Get all presets |
Customer
| API | Description |
|---|---|
| GET api/customers |
Get all customers |
| GET api/customers/{id} |
Get customer by ID |
| POST api/customers |
Create a new customer |
| PUT api/customers/{id} |
Update a customer |
| DELETE api/customers/{id} |
Delete a customer |
Content
| API | Description |
|---|---|
| GET api/contents/customergroup/{customerGroupId} |
No documentation available. |
| POST api/contents/search |
No documentation available. |
| POST api/contents/heads |
No documentation available. |
| POST api/contents/heads/{headId}/root |
No documentation available. |
| PUT api/contents/{contentId}/attach/{headId} |
No documentation available. |
| GET api/contents/{contentId} |
No documentation available. |
| GET api/contents/{contentId}/templates |
No documentation available. |
| PUT api/contents/heads/{headId} |
No documentation available. |
| PUT api/contents/{contentId} |
No documentation available. |
| PUT api/contents/{contentId}/recycle |
No documentation available. |
| PUT api/contents/{contentId}/restore/{parentId} |
No documentation available. |
| PUT api/contents/{contentId}/restore |
No documentation available. |
| PUT api/contents/{contentId}/child |
No documentation available. |
| PUT api/contents/{contentId}/hierarchy |
No documentation available. |
| PUT api/contents/{contentId}/clone |
No documentation available. |
Trigger
| API | Description |
|---|---|
| GET api/triggers |
Get all Triggers |
| GET api/triggers/GetByCustomerGroupId?id={id} |
Get all Triggers by customer group |