post
https://api.zenoti.com/v1/reports/notifications/text/flat_file
Purpose: The purpose of this API is to fetch a list of text notification details associated with a center.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Response Details
| Name | Type | Description |
|---|---|---|
| Notifications | Object | Object containing the name of the centers using the email notifications. |
| page_info | Object | Object containing the pagination details. |
| total | int | Denotes the number of pages in the response. |
| page | int | Denotes the current page of the response. |
| size | int | Denotes the size of the page. |
Notifications Object
| Name | Type | Description |
|---|---|---|
| center_name | string | Name of the center which uses the email notifications. |
| guest_code | string | Code of the guest to whom the email is sent. |
| guest_name | string | Name of the guest to whom the email is sent. |
| message_type_name | string | Type of notification sent to the guest. |
| message | string | This is the message sent to the guest. |
| status | string | Status of the email sent to the guest. |
| reason | string | This is the reason for sending the message. |
| sent_on | date time | Date and time when the message was sent to the guest. |
| sent_to | string | The phone number to which the text message is sent. |
| guest_mobile | string | The phone number of the guest. |
| credits_consumed | int | Denotes the number of text message credits consumed for sending the text message to guest. |
error Object
| Message | Code | Description |
|---|---|---|
| notification template ids are missing | 502 | This error occurs when the notification template ids are not mentioned. |
| center ids are missing | 502 | This error occurs when the center_id parameter is missing. |
| start_date must be earlier than end_date | 502 | This error occurs when an invalid start_date is mentioned. |
| invalid start_date or end_date | 502 | This error occurs when an invalid start_date or end_date is mentioned. |