Skip to main content
POST
/
Agent
/
Xmpp
/
SetRosterItem
Set Roster Item
curl --request POST \
  --url https://{host}/Agent/Xmpp/SetRosterItem \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bareJid": "<string>",
  "name": "<string>",
  "Groups": [
    "<string>"
  ]
}
'
{
  "bareJid": "<string>",
  "pendingSubscription": true,
  "status": "<string>",
  "name": "<string>",
  "Groups": [
    "<string>"
  ]
}

​
Overview

Sets information about a specific roster item for the account.

​
Authentication

Requires a valid JWT bearer token.

​
Notes

This endpoint uses the request schema notation described in Pattern matching.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
bareJid
string
required
​
name
string
required
​
Groups
string[]

Response

200 - application/json

Success

​
bareJid
string
required
​
pendingSubscription
boolean
required
​
status
string
required
​
name
string
required
​
Groups
string[]