Update global application settings

Updates the global application settings that are applied to all channels within the application.

HTTP request

PUT https://api-{application_id}.sendbird.com/v3/applications/settings_global

Request body

The following table lists the properties of an HTTP request that this action supports.

Optional

Property name	Type	Description
display_past_message	boolean	Determines whether to display past messages to new members of a group channel. If set to true, the entire message history of the channel is shown to members who newly join the channel. (Default: false)
allow_links	boolean	Determines whether to allow clickable links in a message within the application. (Default: true)
max_message_length	int	Specifies the maximum character length of a message allowed to be sent within the application. Acceptable values are 50, 100, 200, 500, 1,000, 5,000, 10,000, and 20,000. (Default: 5,000)
user_messages_per_channel	int	Specifies the maximum number of messages which a user is allowed to send in a channel during the time duration set in `user_messages_per_channel_duration` property. A value of -1 indicates that the system limit is imposed. The system allows a user to send up to 5 messages per second. (Default: -1)
user_messages_per_channel_duration	int	Specifies the time duration in seconds in which a user can send the set number of messages in a channel. This property works in conjunction with `user_messages_per_channel`. For example, if the value of `user_messages_per_channel` is 7 and the value of `user_messages_per_channel_duration` is 3, a user can send seven messages in three seconds and any messages beyond the 7th one will be blocked. (Default: 1)
domain_filter	nested object	A domain filter configuration to filter out text and file messages with URLs that contain the domain set.
domain_filter.domains[]	array of strings	Specifies an array of domains to detect. Each item of the array should be specified in a combination of domain name and TLD (top level domain) like amazon.com.
domain_filter.type	int	Determines which filter to apply to messages with URLs that contain any of the domain set. Acceptable values are the following: - 0 (none): takes no action on matching messages. This is the default. - 1 (allow): only allows messages containing URLs that match the domains property. - 2 (block): blocks messages containing URLs that match the domains property. - 3 (replace): detects and replaces URLs that match the domains property with asterisks (*).
profanity_filter	nested object	A filter configuration on certain words and patterns for matching character combinations in strings, which are not allowed to be used within the application.
profanity_filter.keywords[]	array of strings	Specifies an array of words to detect. -word filters all words that end* with "word" including "word" itself. - word* filters all words that start with "word" including "word" itself.
profanity_filter.regex_filters[]	array of strings	Specifies an array of regular expressions used for detecting. Each item of the list should be specified in *{"regex": "a pattern in regular expression"}* format.
profanity_filter.type	int	Determines which filtering method to apply to messages that contain the specified keywords or regular expressions. Acceptable values are the following: - 0 (none): takes no action on matched messages. This is the default. - 1 (replace): detects and replaces words that match the `keywords` property with asterisks (). - 2 (block)*: prevents users from sending messages that contain the `keywords` property or match the `regex_filters` property.
profanity_triggered_moderation	nested object	A moderation configuration on which penalty is automatically imposed on users who reach the profanity violation limit within a channel.
profanity_triggered_moderation.count	int	Specifies the number of profanity violation limit before a penalty is imposed on a user. - A value of 0 indicates that automatically-triggered moderation is turned off. - A value of greater than or equal to 1 indicates that the moderation is turned on and imposes a penalty on a user who commits a number of violations equal to or beyond the set value of the count property within the set time of the duration property. (Default: 0)
profanity_triggered_moderation.duration	int	Specifies the duration of the time window in seconds which counts the number of a user’s violations within a channel. For example, if the count property is 2 and the duration property is 5, the number of violations equal to or beyond 2 will be moderated for every 5 seconds. The maximum value is 86400 which indicates 24 hours. (Default: 1 second)
profanity_triggered_moderation.action	int	Determines the type of moderation penalty within a channel which is permanently imposed on users until canceled. Acceptable values are the following: 0 for no action taken, 1 for muting users, 2 for kicking out users, and 3 for banning users. (Default: 0)
image_moderation	nested object	A moderation configuration on inappropriate images in the application. Google Cloud Vision API is used for image moderation and supports many types of images.
image_moderation.type	int	Determines the moderation method to apply to the images and image URLs in the text and file messages. Acceptable values are the following: - 0 (none): no moderation is imposed. This is the default setting. - 1 (normal): the messages with images or image URLs are blocked if the images or image URLs violate the content policies. - 2 (strict): the file messages with no images are also blocked in addition to the messages with explicit images or inappropriate image URLs.
image_moderation.soft_block	boolean	If true, the moderation method set by the type property above is ignored and no moderation is imposed on the text and file messages in regard to explicit images or inappropriate image URLs. It will only give the image analysis results in the response. If false, the image moderation works according to the moderation method already set.
image_moderation.limits	nested object	A set of values returned after an image has been moderated. These limit numbers range from one to five and specify the likelihood of the image passing the moderation standard. Acceptable likelihood values are the following: 0 for unknown likelihood, 1 when very unlikely, 2 when unlikely, 3 when possible, 4 when likely, and 5 when very likely.
image_moderation.limits.adult	int	Specifies the likelihood of the image containing an adult content.
image_moderation.limits.spoof	int	Specifies spoof likelihood which is the likelihood that a modification was made to the image to make it appear funny or offensive.
image_moderation.limits.medical	int	Specifies the likelihood of the image being a medical image.
image_moderation.limits.violence	int	Specifies the likelihood of the image containing violent content.
image_moderation.limits.racy	int	Specifies the likelihood of the image containing racy content.
image_moderation.check_urls	boolean	Determines whether to check if the image URLs in the text and file messages are appropriate.

Response

If successful, this action returns the created global application settings resource in the response body.

Status: 200 OK

{
    "domain_filter": {
        "domains": ["s3.amazon.com", "vision.googleapis.com"],
        "type": 1,
        "should_check_global": false
    },
    "profanity_filter": {
        "keywords": "ass,snatch,sperm"
        "regex_filters": [
            {
                "regex": "[^!@#$%^&*]*(fuck|prick)[^!@#$%^&*]*"
            },
            {
                "regex": "(http://|https://)?(casino|sex)+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(/.*)?"
            }
        ],
        "type": 2,
        "should_check_global": false
    },
    "max_message_length": 500,
    "display_past_message": true,
    "image_moderation": {   // The default settings of image moderation.
        "type": 0,
        "soft_block": false,
        "limits": {
            "adult": 3,
            "spoof": 5,
            "medical": 5,
            "violence": 3,
            "racy": 4
        },
        "check_urls": false
    },
    "allow_links": true,
    "user_messages_per_channel_duration": 1,
    "user_messages_per_channel": 3,
    "profanity_triggered_moderation": {
        "count": 3,
        "duration": 1,
        "action": 2
    },
    "message_retention_hours": 2400
}

In the case of an error, an error object is returned. A detailed list of error codes is available here.

Try API requests