← FlexAPI Documentation / API Calls / RemoveMeeting

RemoveMeeting

The RemoveMeeting method removes a meeting from a transaction, as long as at least one other transaction still has that meeting. This prevents meetings from being orphaned from every transaction. See Zoom Meeting Linking for the overview. Available in SIGNiX release 180.

Before you call

  • The transaction must have no completed tasks. You cannot remove a meeting from a transaction that has a completed task.
  • At least one other transaction must still have the meeting. A meeting cannot be left without any transaction, so you cannot remove its last remaining association.
  • The transaction history shows the removal. An Online Meeting Removed event appears on the transaction.
  • Use the same CustInfo credentials as your other requests (Sponsor, Client, UserId and Pswd).

RemoveMeeting - Request XML

An annotated example of the request XML follows. MeetingLink identifies the meeting and the transaction you are removing it from.

RemoveMeeting - annotated request
<?xml version="1.0" ?>
<RemoveMeetingRq xmlns="urn:com:signix:schema:sdddc-1-1">

  <CustInfo> <!-- Occurs once only -->

    <!-- Assigned by SIGNiX when the Client is set up. All case sensitive. -->
    <Sponsor>YOUR_SPONSOR</Sponsor>
    <Client>YOUR_CLIENT</Client>
    <UserId>YOUR_USER</UserId>
    <Pswd>YOUR_PASSWORD</Pswd>

  </CustInfo>

  <Data> <!-- Occurs once only -->

    <MeetingLink>
      <!-- All three elements are required. -->
      <DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID> <!-- The transaction you are removing the meeting from. It must have no completed tasks. -->
      <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID> <!-- The meeting to remove from that transaction -->
      <Part>1</Part> <!-- Almost always 1 -->
    </MeetingLink>

  </Data>

</RemoveMeetingRq>

RemoveMeeting - Response XML

An annotated example of the response XML follows. See Status Codes on the main API page for the possible values and meanings of the StatusCode and StatusDesc elements.

On success, the response describes the meeting that was removed. The SubmitterMeetingLink is the host link for the notary, so treat it as sensitive.

RemoveMeeting - annotated response
<?xml version="1.0" ?>
<RemoveMeetingRs xmlns="urn:com:signix:schema:sdddc-1-1">

  <Status> <!-- Occurs once only -->
    <StatusCode>0</StatusCode> <!-- One of the numeric SC_* values -->
    <StatusDesc>success</StatusDesc> <!-- Human-readable version of StatusCode -->
  </Status>

  <Data> <!-- Optional. Occurs when Status.StatusCode is 0. -->

    <MeetingMetadata> <!-- The meeting that was removed -->

      <DocumentSetID>YOUR_DOCUMENT_SET_ID</DocumentSetID>
      <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
      <Part>1</Part>
      <MeetingDateTime>10/07/2025 07:00 AM US/Eastern</MeetingDateTime>

      <!-- Unavailable until the meeting recording has been processed. -->
      <Status>Unavailable</Status>

      <SubmitterMeetingLink>YOUR_SUBMITTER_MEETING_LINK</SubmitterMeetingLink> <!-- Host link (notary). Treat as sensitive. -->
      <SignerMeetingLink>YOUR_SIGNER_MEETING_LINK</SignerMeetingLink> <!-- Participant link (signer / witness) -->

    </MeetingMetadata>

  </Data>

</RemoveMeetingRs>

Error response

If the transaction has a completed task, the meeting is not removed and the request returns an error like the following. A request that would leave the meeting with no transaction is also refused with an error. Check StatusCode before reading anything else, and use StatusDesc to see the reason.

RemoveMeeting - annotated response (completed tasks)
<?xml version="1.0" ?>
<RemoveMeetingRs xmlns="urn:com:signix:schema:sdddc-1-1">

  <Status>
    <StatusCode>100</StatusCode> <!-- Non-zero: the meeting was not removed -->
    <StatusDesc>Unable to remove existing meeting: The meeting cannot be removed because this transaction has completed tasks.</StatusDesc>
  </Status>

  <!-- No Data element on an error. -->

</RemoveMeetingRs>