POST /v1/Services/{ChatServiceSid}/Configuration/Notifications

Update push notification service settings

Servers

Path parameters

Name Type Required Description
ChatServiceSid String Yes

The SID of the Conversation Service the Configuration applies to.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
AddedToConversation.Template String No

The template to use to create the notification text displayed when a participant is added to a conversation and added_to_conversation.enabled is true.

RemovedFromConversation.Template String No

The template to use to create the notification text displayed to a user when they are removed from a conversation and removed_from_conversation.enabled is true.

LogEnabled Boolean No

Weather the notification logging is enabled.

NewMessage.Sound String No

The name of the sound to play when a new message is added to a conversation and new_message.enabled is true.

AddedToConversation.Sound String No

The name of the sound to play when a participant is added to a conversation and added_to_conversation.enabled is true.

RemovedFromConversation.Enabled Boolean No

Whether to send a notification to a user when they are removed from a conversation. The default is false.

NewMessage.Enabled Boolean No

Whether to send a notification when a new message is added to a conversation. The default is false.

AddedToConversation.Enabled Boolean No

Whether to send a notification when a participant is added to a conversation. The default is false.

NewMessage.BadgeCountEnabled Boolean No

Whether the new message badge is enabled. The default is false.

RemovedFromConversation.Sound String No

The name of the sound to play to a user when they are removed from a conversation and removed_from_conversation.enabled is true.

NewMessage.WithMedia.Enabled Boolean No

Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is false.

NewMessage.WithMedia.Template String No

The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and new_message.attachments.enabled is true.

NewMessage.Template String No

The template to use to create the notification text displayed when a new message is added to a conversation and new_message.enabled is true.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.