V200611


Click here for a complete list of operations.

CreateCustomField

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/CreateCustomField"

<?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>
    <CreateCustomField xmlns="http://api.cvent.com/2006-11">
      <CustomFieldCategory>AppointmentCustomField or BudgetItemCustomField or CampaignCustomField or ContactCustomField or EventCustomField or ResourceCustomField or RFPCustomField or SessionCustomField or SurveyCustomField or UserCustomField</CustomFieldCategory>
      <CustomFields>
        <EntityCustomField FieldName="string" FieldCode="string" HelpText="string" FieldType="string" AnswerFormat="string" MinimumCharacters="int" MaximumCharacters="int" MinimumNumber="int" MaximumNumber="int" PrepopulateCurrentDate="boolean" EarliestDate="dateTime" LatestDate="dateTime" DisplayPopUpCalendar="boolean">
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
        </EntityCustomField>
        <EntityCustomField FieldName="string" FieldCode="string" HelpText="string" FieldType="string" AnswerFormat="string" MinimumCharacters="int" MaximumCharacters="int" MinimumNumber="int" MaximumNumber="int" PrepopulateCurrentDate="boolean" EarliestDate="dateTime" LatestDate="dateTime" DisplayPopUpCalendar="boolean">
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
        </EntityCustomField>
      </CustomFields>
    </CreateCustomField>
  </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>
    <CreateCustomFieldResponse xmlns="http://api.cvent.com/2006-11">
      <CreateCustomFieldResult xmlns="http://schemas.cvent.com/api/2006-11">
        <CreateCustomFieldResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </CreateCustomFieldResult>
        <CreateCustomFieldResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </CreateCustomFieldResult>
      </CreateCustomFieldResult>
    </CreateCustomFieldResponse>
  </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>
    <CreateCustomField xmlns="http://api.cvent.com/2006-11">
      <CustomFieldCategory>AppointmentCustomField or BudgetItemCustomField or CampaignCustomField or ContactCustomField or EventCustomField or ResourceCustomField or RFPCustomField or SessionCustomField or SurveyCustomField or UserCustomField</CustomFieldCategory>
      <CustomFields>
        <EntityCustomField FieldName="string" FieldCode="string" HelpText="string" FieldType="string" AnswerFormat="string" MinimumCharacters="int" MaximumCharacters="int" MinimumNumber="int" MaximumNumber="int" PrepopulateCurrentDate="boolean" EarliestDate="dateTime" LatestDate="dateTime" DisplayPopUpCalendar="boolean">
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
        </EntityCustomField>
        <EntityCustomField FieldName="string" FieldCode="string" HelpText="string" FieldType="string" AnswerFormat="string" MinimumCharacters="int" MaximumCharacters="int" MinimumNumber="int" MaximumNumber="int" PrepopulateCurrentDate="boolean" EarliestDate="dateTime" LatestDate="dateTime" DisplayPopUpCalendar="boolean">
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
          <FieldChoices xmlns="http://schemas.cvent.com/api/2006-11">
            <FieldChoiceText>string</FieldChoiceText>
          </FieldChoices>
        </EntityCustomField>
      </CustomFields>
    </CreateCustomField>
  </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>
    <CreateCustomFieldResponse xmlns="http://api.cvent.com/2006-11">
      <CreateCustomFieldResult xmlns="http://schemas.cvent.com/api/2006-11">
        <CreateCustomFieldResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </CreateCustomFieldResult>
        <CreateCustomFieldResult Id="string" ReferenceId="string" Success="boolean">
          <Errors>
            <Error xsi:nil="true" />
            <Error xsi:nil="true" />
          </Errors>
        </CreateCustomFieldResult>
      </CreateCustomFieldResult>
    </CreateCustomFieldResponse>
  </soap12:Body>
</soap12:Envelope>