Skip to main content
POST
/
Agent
/
Xmpp
/
SendPresenceSubscription
Send Presence Subscription
curl --request POST \
  --url https://{host}/Agent/Xmpp/SendPresenceSubscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "customXml": "<string>",
  "language": "<string>",
  "id": "<string>"
}
'
{
  "sent": true,
  "id": "<string>",
  "RosterItem": {
    "bareJid": "<string>",
    "pendingSubscription": true,
    "status": "<string>",
    "name": "<string>",
    "Groups": [
      "<string>"
    ]
  }
}

​
Overview

Allows the client to send a presence subscription from its account to an XMPP recipient. If the account to which the client is logged in has an approved Legal ID associated with it, this ID will be included in the request, to allow the recipient to know who has made the request.

​
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
​
to
string
required
​
customXml
string
​
language
string
​
id
string

Response

200 - application/json

Success

​
sent
boolean
required
​
id
string
required
​
RosterItem
object
required