User Muting

Allow registered users to mute other registered users

If Single Sign On is enabled for your site, you can permit a registered user to mute another registered user in all Conversations in which they both participate.

πŸ“˜

To use this API, request that it be enabled for your Spot ID from your OpenWeb PSM.



Mute user

/v1/users/mute-user
Mutes a specific registered user in a Conversation


Request

curl -L -X POST 'https://api.openweb.com/v1/users/mute-user' \
     -H 'x-spot-id: SPOT_ID' \
     -H 'apikey: API_KEY' \
     -H 'Content-Type: application/json' \
     -d '{
         "primary_key": "USER-MUTING-A-USER",
         "primary_key_to_mute": "USER-TO-MUTE"
        }'

Header Parameters

Parameter Description
apikey* string Unique OpenWeb export token

  1. From your OpenWeb Admin Dashboard, click Settings.
  2. Under Authentication Tokens, copy the Export value.
x-spot-id* string Unique OpenWeb identifier for your property

  1. Log into your Admin Dashboard.
  2. Copy your Spot ID from the URL: https://admin.spot.im/spot/{SPOT_ID}/...


Body Parameters

Parameter Description
primary_key* string Unique user ID generated by a Partner's backend user management system

This is the ID of the user applying the mute functionality to another user.
primary_key_to_mute* string Unique user ID generated by a Partner's backend user management system

This is the ID of the user being muted.


Response

A successful response, returns an empty object with a 204 status.

{}


Unmute user

/v1/users/mute-user
Unmutes a specific registered user in a Conversation


Request

curl -L -X DELETE 'https://api.openweb.com/v1/users/mute-user' \
     -H 'x-spot-id: SPOT_ID' \
     -H 'apikey: API_KEY' \
     -H 'Content-Type: application/json' \
     -d '{
         "primary_key": "USER-MUTING-A-USER",
         "primary_key_to_mute": "USER-TO-MUTE"
        }'

Header Parameters

Parameter Description
apikey* string Unique OpenWeb export token

  1. From your OpenWeb Admin Dashboard, click Settings.
  2. Under Authentication Tokens, copy the Export value.
x-spot-id* string Unique OpenWeb identifier for your property

  1. Log into your Admin Dashboard.
  2. Copy your Spot ID from the URL: https://admin.spot.im/spot/{SPOT_ID}/...


Body Parameters

Parameter Description
primary_key* string Unique user ID generated by a Partner's backend user management system

This is the ID of the user applying the mute functionality to another user.
primary_key_to_mute* string Unique user ID generated by a Partner's backend user management system

This is the ID of the user being muted.


Response

A successful response, returns an empty object with a 204 status.

{}