Skip to main content

​
Overview

Sets information about a specific roster item for the account.

​
HTTP request

POST /Agent/Xmpp/SetRosterItem

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"bareJid":Required(Str(PBareJid)),
	"name": Required(Str(PName)),
	"Groups": Optional(Str(PGroups)[])
}

​
Input parameters

ParameterDescription
PBareJidBare JID of roster item.
PNameName to assign to the roster item.
PGroupsGroups to assign to the roster item.

​
Response (JSON)

{
	"bareJid": Required(Str(PBareJid)),
	"pendingSubscription": Required(Bool(PPendingSubscription)),
	"status": Required(Str(PStatus)),
	"name": Required(Str(PName)),
	"Groups": Optional(Str(PGroups)[])
}

​
Response parameters

ParameterDescription
PBareJidBare JID of roster item.
PPendingSubscriptionIf the account has a pending subscription request to the remote entity.
PStatusStatus of roster item.
PNameName given to the roster item.
PGroupsNames of groups to which the roster item is assigned.

​
Notes

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