PApartoo
Messaging Settings

Update messaging settings

This endpoint lets you update a specific Messaging Settings.

post/messaging/settings/{setting_id}

Request

Path parameters

setting_idinteger required

The id of the Messaging Settings to update

Request body

welcome_messagestring 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_messagestring 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_hoursboolean nullable

If set to true, the business' "open_hours" will be used as chat hours.
Otherwise, you need to specify "custom_chat_hours".

is_launchedboolean 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)

Example request

{
  "custom_chat_hours": {
    "monday": [
      "10:00-14:00"
    ],
    "tuesday": [
      "10:00-14:00"
    ],
    "wednesday": [
      "10:00-14:00"
    ],
    "thursday": [
      "10:00-14:00"
    ],
    "friday": [
      "10:00-14:00"
    ],
    "saturday": [
      "10:00-14:00"
    ],
    "sunday": [
      "10:00-14:00"
    ]
  }
}

Response

OK

idinteger
business_idstring

The ID of the business that the MessagingSetting is related to.

business_namestring nullable

The Name of the business that the MessagingSetting is related to.

business_addressstring nullable

The Formatted address of the business that the MessagingSetting isrelated to.

welcome_messagestring 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_messagestring 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_hoursboolean nullable

If set to true, the business' "open_hours" will be used as chat hours.
Otherwise, you need to specify "custom_chat_hours".

is_launchedboolean 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)

Example response

{
  "business_address": "1 Rue de la Paix, 75000 Paris",
  "custom_chat_hours": {
    "monday": [
      "10:00-14:00"
    ],
    "tuesday": [
      "10:00-14:00"
    ],
    "wednesday": [
      "10:00-14:00"
    ],
    "thursday": [
      "10:00-14:00"
    ],
    "friday": [
      "10:00-14:00"
    ],
    "saturday": [
      "10:00-14:00"
    ],
    "sunday": [
      "10:00-14:00"
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.