← FlexAPI Documentation / API Calls / UpdateMeeting

UpdateMeeting

The UpdateMeeting method moves a meeting from one transaction to another. The meeting is re-assigned to the destination transaction, and the source transaction no longer has it. To give a transaction an additional meeting while the original keeps it, use AddMeeting instead. See Zoom Meeting Linking for the overview. Available in SIGNiX release 180.

Before you call

  • Neither transaction may have a completed task. This applies to both the source transaction the meeting is moving from and the destination transaction it is moving to.
  • Both transactions must be in the same client account.
  • The source transaction loses the meeting. After the call it no longer has a link to the meeting. The transaction history shows an Online Meeting Removed event on the source and an Online Meeting Updated event on the destination.
  • The two DocumentSetID elements mean different things. The one directly under Data is the destination. The one inside MeetingLink is the source.
  • Use the same CustInfo credentials as your other requests (Sponsor, Client, UserId and Pswd).

UpdateMeeting - Request XML

An annotated example of the request XML follows. It identifies the destination transaction and the meeting to move, along with the source transaction it currently belongs to.

UpdateMeeting - annotated request
<?xml version="1.0" ?>
<UpdateMeetingRq 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 -->

    <!-- Required. The destination transaction: the one the meeting is moving TO. -->
    <DocumentSetID>YOUR_DESTINATION_DOCUMENT_SET_ID</DocumentSetID>

    <MeetingLink>
      <!-- All three elements are required. -->
      <DocumentSetID>YOUR_SOURCE_DOCUMENT_SET_ID</DocumentSetID> <!-- The source transaction: the one the meeting is moving FROM -->
      <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID> <!-- The meeting being moved -->
      <Part>1</Part> <!-- Almost always 1 -->
    </MeetingLink>

  </Data>

</UpdateMeetingRq>

UpdateMeeting - 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 reflects the meeting after it was moved. The DocumentSetID in MeetingMetadata is the transaction the meeting now belongs to. The SubmitterMeetingLink is the host link for the notary, so treat it as sensitive.

UpdateMeeting - annotated response
<?xml version="1.0" ?>
<UpdateMeetingRs 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, after it was moved -->

      <DocumentSetID>YOUR_DESTINATION_DOCUMENT_SET_ID</DocumentSetID>
      <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID>
      <Part>1</Part>
      <MeetingDateTime>10/08/2025 08: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>

</UpdateMeetingRs>

Error response

If a transaction involved has a completed task, the meeting is not moved and the request returns an error like the following. Check StatusCode before reading anything else, and use StatusDesc to see the reason.

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

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

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

</UpdateMeetingRs>