← FlexAPI Documentation / API Calls / AddMeeting

AddMeeting

The AddMeeting method adds a meeting to an existing transaction. You can create a new meeting with a MeetingInfo element, or link an existing meeting from another transaction with a MeetingLink element. See Zoom Meeting Linking for the overview. Available in SIGNiX release 180.

Before you call

  • The destination transaction must have no completed tasks. To create a new meeting, only the transaction you are adding the meeting to is checked. To link an existing meeting, neither that transaction nor the transaction the meeting comes from may have a completed task.
  • Both transactions must be in the same client account when linking.
  • To move a meeting, use UpdateMeeting. AddMeeting keeps the meeting in its original transaction as well, so the meeting then belongs to both.
  • Send MeetingInfo to create a meeting, or MeetingLink to link one. The MeetingInfo rules (time zones, timing) are the same as in SubmitDocument.
  • A transaction can have more than one meeting. This is supported for future flexibility, but is not expected to be common, since the notary and signer would not normally be in several meetings.
  • Use the same CustInfo credentials as your other requests (Sponsor, Client, UserId and Pswd).

AddMeeting - Request XML

Annotated examples of the request XML follow, one for creating a new meeting and one for linking an existing meeting. In both, the DocumentSetID directly under Data is the transaction you are adding the meeting to.

Create a new meeting

AddMeeting - annotated request (new meeting)
<?xml version="1.0" ?>
<AddMeetingRq 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 transaction you are adding the meeting to. It must have no completed tasks. -->
    <DocumentSetID>YOUR_DESTINATION_DOCUMENT_SET_ID</DocumentSetID>

    <!-- The new meeting. Same rules as MeetingInfo in SubmitDocument. -->
    <MeetingInfo>
      <Date>09/23/2026</Date> <!-- Required -->
      <Time>06:30 PM</Time> <!-- Required -->
      <Timezone>US/Mountain</Timezone> <!-- Required -->
    </MeetingInfo>

  </Data>

</AddMeetingRq>

Link an existing meeting

Use MeetingLink to identify the meeting you are linking. If you intend to move a meeting from one transaction to another, use UpdateMeeting instead.

AddMeeting - annotated request (link an existing meeting)
<?xml version="1.0" ?>
<AddMeetingRq 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, to which you are adding the meeting. -->
    <DocumentSetID>YOUR_DESTINATION_DOCUMENT_SET_ID</DocumentSetID>

    <MeetingLink>
      <!-- All three elements are required. -->
      <DocumentSetID>YOUR_SOURCE_DOCUMENT_SET_ID</DocumentSetID> <!-- Source transaction, which currently has the meeting -->
      <MeetingUUID>YOUR_MEETING_UUID</MeetingUUID> <!-- The meeting to link -->
      <Part>1</Part> <!-- Almost always 1 -->
    </MeetingLink>

  </Data>

</AddMeetingRq>

AddMeeting - 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.

  • Check that StatusCode is 0 before reading anything else. If the meeting cannot be added, for example because a transaction involved has a completed task, the response carries a non-zero StatusCode and a StatusDesc that explains why.
  • On success, MeetingMetadata describes the meeting that was added, with the same details a SubmitDocument response gives for a meeting.
  • The SubmitterMeetingLink is the host link for the notary. Treat it as sensitive. The SignerMeetingLink is for signers and witnesses.
  • If the transaction already had a meeting, it now has two. The response describes only the meeting you just added, so call GetMeetings to see both.
AddMeeting - annotated response
<?xml version="1.0" ?>
<AddMeetingRs 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 added -->

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

</AddMeetingRs>