Skip to content

RemoveUsergroupFromDocumentSubscribers

# RemoveUsergroupFromDocumentSubscribers API

Removes a specified user group from the subscription list of a document. After removal, members of that group will no longer receive email notifications via the group subscription for any events on that document. Use this API to clean up group subscriptions when a group no longer needs to track a document.

Endpoint

/srv.asmx/RemoveUsergroupFromDocumentSubscribers

Methods

  • GET /srv.asmx/RemoveUsergroupFromDocumentSubscribers?authenticationTicket=...&documentPath=...&groupName=...

  • POST /srv.asmx/RemoveUsergroupFromDocumentSubscribers (form data)

  • SOAP Action: http://tempuri.org/RemoveUsergroupFromDocumentSubscribers

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser.
documentPath string Yes Full infoRouter path to the document (e.g. /Finance/Reports/Q1-Report.pdf). Supports short document ID paths (~D{id} or ~D{id}.ext).
groupName string Yes Name of the user group to remove from the subscription list. Can be a local or global group.

Response

Success Response

<response success="true" error="" />

Error Response

<response success="false" error="User group not found." />

Required Permissions

The calling user must be authenticated. To remove a user group from the subscription list, the calling user must have write access or manage access to the document.

Example

GET Request

GET /srv.asmx/RemoveUsergroupFromDocumentSubscribers

  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

  &documentPath=/Finance/Reports/Q1-2024-Report.pdf

  &groupName=Finance-Managers

HTTP/1.1

POST Request

POST /srv.asmx/RemoveUsergroupFromDocumentSubscribers HTTP/1.1

Content-Type: application/x-www-form-urlencoded



authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301

&documentPath=/Finance/Reports/Q1-2024-Report.pdf

&groupName=Finance-Managers

SOAP Request

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

               xmlns:tns="http://tempuri.org/">

  <soap:Body>

    <tns:RemoveUsergroupFromDocumentSubscribers>

      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>

      <tns:DocumentPath>/Finance/Reports/Q1-2024-Report.pdf</tns:DocumentPath>

      <tns:groupName>Finance-Managers</tns:groupName>

    </tns:RemoveUsergroupFromDocumentSubscribers>

  </soap:Body>

</soap:Envelope>

Notes

  • Not Subscribed: If the specified group is not currently subscribed to the document, the API returns success="true" -" it does not treat this as an error.

  • Group Must Exist: The groupName must match an existing infoRouter user group. If the group is not found, an error is returned.

  • Individual User Subscriptions Unaffected: This API only removes the group-level subscription. Individual users who happen to be members of this group and have their own personal subscriptions will continue to receive notifications. Use RemoveUserFromDocumentSubscribers to remove individual user subscriptions.

  • Short Path Support: The documentPath parameter supports short document ID notation: ~D123 or ~D123.pdf.

  • Folder Group Subscriptions: This API operates on document subscriptions only. To remove a group from a folder subscription, use RemoveUsergroupFromFolderSubscribers.

Error Codes

Error Description
[900] Authentication failed Invalid or missing authentication ticket.
[901] Session expired or Invalid ticket The ticket has expired or does not exist.
Document not found The specified documentPath does not resolve to an existing document.
User group not found The specified groupName does not match an existing user group.
Insufficient rights The calling user does not have permission to manage subscriptions for this document.
SystemError:... An unexpected server-side error occurred.