Type list
Retrieves a paginated list of available message types with their configuration and permission status. This endpoint helps understand what types of messages can be sent and which are enabled for the cu
Endpoint
GET/v2/messages/types
Link
Request
Query Parameters
meta.page
integer
Page number (starts from 0).
No
0
meta.pageSize
integer
Number of items per page.
No
20
Headers
Authorization
Bearer <JWT>
Yes
Accept
application/json
Yes
Response (200 OK)
Returns a paginated list of message types with their configuration.
Response Fields
1. Meta Object
pageSize
integer
Items per page.
20
page
integer
Current page number.
0
total
string
Total message types available.
"5"
2. Message Type Object (items[])
id
integer
Unique type identifier.
1
name
string
Type name (descriptive).
"Email"
isAllowed
boolean
Permission status for current partner. true = enabled.
true
Example Response:
json
Examples
Request
bash
Request with Pagination
bash
Common Message Types
1- Email: Standard email notifications2- SMS: Text message notifications3- Push Notification: Mobile app push messages4- In-App Notification: Platform internal notifications5- Webhook: External system notifications
Error Responses
Unauthorized:
json
Invalid Page:
json
Notes
Permission-Based:
isAllowedindicates whether the current partner can use this message type.Configuration: Message types may have additional configuration requirements (e.g., SMTP for email, SMS gateway for SMS).
Pagination: Default
pageSizeis typically 20-50 items.Real-time: The list reflects current system configuration and partner permissions.
Usage Examples:
Display available message channels in UI dropdowns
Conditionally show/hide features based on
isAllowedValidate template creation requests
Real request sample
Real response sample:
Last updated

