---
title: "List messaging settings"
method: GET
path: "/messaging/settings"
tags: ["Messaging Settings"]
---

# List messaging settings

`GET /messaging/settings`

This endpoint lets you list all the Messaging Settings you have access to.

You can filter the Messaging Settings based on the Organization or the
Business that they are related to.

## Query parameters

- `page` integer
- `per_page` integer
- `business__in` BusinessId[]

## Response `200`

OK

- object — Response object
  - `settings` MessagingSetting[] — The list of Messaging Settings, paginated.
    - `id` integer
    - `business_id` string — The ID of the business that the MessagingSetting is related to.
    - `business_name` string, nullable — The Name of the business that the MessagingSetting is related to.
    - `business_address` string, nullable — The Formatted address of the business that the MessagingSetting isrelated to.
    - `welcome_message` string, nullable — When a consumer first contacts the business, an automated reply is sent. The content of the reply depends on whether the consumer contacted the business during it's chat hours. If it is, the welcome_message is sent as a reply. The welcome_message is mandatory, and can be customized. A default will be set if none is specified.
    - `offline_message` string, nullable — When a consumer first contacts the business, an automated reply is sent. The content of the reply depends on whether the consumer contacted the business during it's chat hours. If it is not, the offline_message is sent as a reply. The offline_message is mandatory, and can be customized. A default will be set if none is specified.
    - `uses_business_hours` boolean, nullable — If set to true, the business' "open_hours" will be used as chat hours. Otherwise, you need to specify "custom_chat_hours".
    - `custom_chat_hours` ChatHours, nullable — The chat hours of the business (in its timezone). Chat hours are specified per weekday. This is done by supplying an object mapping weekdays ("monday", "tuesday", etc.) to a list of strings. These strings in turn represent time slots during which the business is open. For example, the following value would set the chat hours to between 08:00-15:00 in the afternoon and 18:00-23:00 in the evening on Mondays: `{"monday": ["08:00-15:00", "18:00-23:00"]}` To indicate that a business can be contacted for 24 hours, for a specific weekday, use the value `["00:00-23:59"]`. This field is not mandatory unless "uses_business_hours" is set to false.
      - `monday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `tuesday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `wednesday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `thursday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `friday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `saturday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
      - `sunday` TimeWindow[], required — Open in the morning and in the evening `[10:00-14:00, 18:00-00:00]`. Closed the whole day `[]`
    - `is_launched` boolean, nullable — Some messaging channels (Google and Facebook) can be temporarily deactivated. This allows the business to close for a period of time without having to answer consumer messages. This is important because consumers will get frustrated if they are able to contact a business and do not get an answer. It is also important to note that for some messaging channels, not responding to messages may lead to decreased visibility of the business, or suspension of the messaging service. The is_launched property indicates whether the business is reachable for those messaging channels. The value can be updated, and the changes will be propagated to the messaging channels, effectively toggling the On or Off the ability for consumers to reach the business. (The change to "is_launched" is made asychronously, and the update will be effective when the messaging channels have finished propagating the information)
  - `page` integer — The current page number.
  - `count` integer — Total number of results available for the filters and dimensions requested.
  - `max_page` integer — Total number of pages available for this request.

## Other responses

- `401` — You are not authenticated
- `403` — You are not allowed to perform this action

---

[API](https://skmtc.net/partoo/apis/partoo-rest-api.md) · [All operations](https://skmtc.net/partoo/apis/partoo-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/partoo/partoo-rest-api/revisions/3652d8b1a8b3/schema)