V200611

Click here for a complete list of operations.

SendEmail

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/V200611.ASMX HTTP/1.1
Host: api.cvent.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.cvent.com/2006-11/SendEmail"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap:Header>
  <soap:Body>
    <SendEmail xmlns="http://api.cvent.com/2006-11">
      <EmailRequest ActivityType="Event or Survey or Campaigns" ActivityId="string" EmailTemplateName="Invitation or CustomInviteeMessage or InvitationReminder or CustomUndecidedMessage or RegistrationConfirmation or EventReminder or CustomAttendeeMessage or ModificationConfirmation or CancellationConfirmation or Regret or CustomDeclineeMessage or PostEventFollowUp or CustomAttendedMessage or ApprovalDenied or ApprovalPending or CustomEmail or SurveyInvitation or SurveyCustomInviteeMessage or SurveyReminder or SurveyCustomNoResponseMessage or SurveyPartiallyCompleteMessage or SurveyCustomMessageToPartials or SurveyCompletionMessage or SurveyCustomMessageToRespondents or SurveyCustomEmail or SurveyInvitationWithQuestion" ResendToPreviousRecipients="boolean" EmailName="string" xmlns="http://schemas.cvent.com/api/2006-11">
        <RecipientId>
          <CvObject Id="string" MessageId="string" TransactionID="string" />
          <CvObject Id="string" MessageId="string" TransactionID="string" />
        </RecipientId>
      </EmailRequest>
    </SendEmail>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap:Header>
  <soap:Body>
    <SendEmailResponse xmlns="http://api.cvent.com/2006-11">
      <SendEmailResult xmlns="http://schemas.cvent.com/api/2006-11">
        <SendEmailResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </SendEmailResult>
        <SendEmailResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </SendEmailResult>
      </SendEmailResult>
    </SendEmailResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /soap/V200611.ASMX HTTP/1.1
Host: api.cvent.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap12:Header>
  <soap12:Body>
    <SendEmail xmlns="http://api.cvent.com/2006-11">
      <EmailRequest ActivityType="Event or Survey or Campaigns" ActivityId="string" EmailTemplateName="Invitation or CustomInviteeMessage or InvitationReminder or CustomUndecidedMessage or RegistrationConfirmation or EventReminder or CustomAttendeeMessage or ModificationConfirmation or CancellationConfirmation or Regret or CustomDeclineeMessage or PostEventFollowUp or CustomAttendedMessage or ApprovalDenied or ApprovalPending or CustomEmail or SurveyInvitation or SurveyCustomInviteeMessage or SurveyReminder or SurveyCustomNoResponseMessage or SurveyPartiallyCompleteMessage or SurveyCustomMessageToPartials or SurveyCompletionMessage or SurveyCustomMessageToRespondents or SurveyCustomEmail or SurveyInvitationWithQuestion" ResendToPreviousRecipients="boolean" EmailName="string" xmlns="http://schemas.cvent.com/api/2006-11">
        <RecipientId>
          <CvObject Id="string" MessageId="string" TransactionID="string" />
          <CvObject Id="string" MessageId="string" TransactionID="string" />
        </RecipientId>
      </EmailRequest>
    </SendEmail>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <CventSessionHeader xmlns="http://api.cvent.com/2006-11">
      <CventSessionValue>string</CventSessionValue>
    </CventSessionHeader>
  </soap12:Header>
  <soap12:Body>
    <SendEmailResponse xmlns="http://api.cvent.com/2006-11">
      <SendEmailResult xmlns="http://schemas.cvent.com/api/2006-11">
        <SendEmailResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </SendEmailResult>
        <SendEmailResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </SendEmailResult>
      </SendEmailResult>
    </SendEmailResponse>
  </soap12:Body>
</soap12:Envelope>