POST {clientId}/DataExport/ExportSchedules

Add ExportSchedules.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId	Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid.	string	Required

Body Parameters

Export Schedule class instance containing collection of ExportSchedules to import

ExportScheduleResult

Name	Description	Type	Additional information
ExportSchedules		Collection of ExportSchedule	None.

Request Formats

application/json, text/json

Sample:

{
  "ExportSchedules": [
    {
      "ExportScheduleLink": 1,
      "ClientLink": 2,
      "SearchLink": 3,
      "Name": "sample string 4",
      "SegmentGroupName": "sample string 5",
      "Description": "sample string 6",
      "FileNameBase": "sample string 7",
      "ExportScheduleDateSuffixNbr": 8,
      "ExportScheduleTimeSuffixNbr": 9,
      "ExportSchedulePeriodNbr": 10,
      "BeginGenerateFileOn": "2025-12-30T00:28:54.2887608-05:00",
      "EndGenerateFileOn": "2025-12-30T00:28:54.2887608-05:00",
      "GenerateTimeZoneId": "sample string 12",
      "GenerateTimeZoneUtcOffsetTotalMinutes": 13,
      "ExportScheduleTypeNbr": 14,
      "InteractiveDataRetrieval": true,
      "SFTPDataRetrieval": true,
      "APIDataRetrieval": true,
      "SFTPFolderName": "sample string 18",
      "APIScheduleId": "sample string 19",
      "ExportScheduleFieldDelimiterNbr": 20,
      "ExportScheduleNewlineDelimiterNbr": 21,
      "IncludeColumnLabels": true,
      "IncludeHeaderRecord": true,
      "IncludeFooterRecord": true,
      "IncludeHeaderRecordFlagCodeField": true,
      "HeaderRecordFlagCode": "sample string 26",
      "IncludeHeaderScheduleNameField": true,
      "IncludeHeaderChannelIdField": true,
      "IncludeHeaderFileTypeField": true,
      "IncludeHeaderProcessDateField": true,
      "IncludeHeaderProcessTimeField": true,
      "FooterRecordFlagCode": "sample string 32",
      "IncludeFooterRecordFlagCodeField": true,
      "IncludeFooterDetailRecordCountField": true,
      "IncludeFooterTotalRecordCountField": true,
      "IncludeFooterFileTypeField": true,
      "IncludeFooterProcessDateField": true,
      "IncludeFooterProcessTimeField": true,
      "DetailRecordFlagCode": "sample string 39",
      "SendOnFileGenerationSuccessful": true,
      "FileGenerationSuccessfulEmailSubject": "sample string 41",
      "SendOnFileGenerationFailed": true,
      "FileGenerationFailedEmailSubject": "sample string 43",
      "IsDeactivated": true,
      "FileGenerationTime": "00:00:00.1234567",
      "SearchOutputFormatNbr": 45,
      "ExportScheduleFileEncodingNbr": 46,
      "UseCustomPreferenceTypeIdentifiers": true,
      "CustomOptInIdentifier": "sample string 48",
      "CustomOptOutIdentifier": "sample string 49",
      "ExportDateFormatNbr": 50,
      "PGPEncryptOutput": true,
      "ExportScheduleOutputFieldSets": [
        {
          "SearchOutputFieldSetLink": 1,
          "SearchOutputFormatNbr": 2,
          "ExportScheduleOutputFields": [
            {
              "ExportScheduleOutputFieldLink": 1,
              "SearchOutputFieldSetLink": 2,
              "SearchOutputFieldLink": 3,
              "OrderNumber": 4,
              "DisplayFieldName": "sample string 5",
              "ActualColumnName": "sample string 6",
              "Description": "sample string 7",
              "DefaultOrderNumber": 8,
              "SearchOutputFieldTypeNbr": 9,
              "Indent": 10,
              "ParentLink": 1,
              "GrandParentLink": 1,
              "GreatGrandParentLink": 1,
              "GreatGreatGrandParentLink": 1,
              "IsAttributeColumn": true,
              "IsFilterHeaderColumn": true,
              "IsProgramColumn": true,
              "IsFilterHeaderPropertyColumn": true,
              "IsProgramPropertyColumn": true,
              "ElementLink": 16,
              "PropertyLink": 17
            }
          ]
        }
      ],
      "ExportScheduleNotifications": [
        {
          "ExportScheduleRecipientLink": 1,
          "ExportScheduleRecipientTypeNbr": 2,
          "DistributionListLink": 3,
          "Name": "sample string 4",
          "Description": "sample string 5"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ExportScheduleResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
  <ExportSchedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
    <d2p1:ExportSchedule>
      <d2p1:APIDataRetrieval>true</d2p1:APIDataRetrieval>
      <d2p1:APIScheduleId>sample string 19</d2p1:APIScheduleId>
      <d2p1:BeginGenerateFileOn>2025-12-30T00:28:54.2887608-05:00</d2p1:BeginGenerateFileOn>
      <d2p1:ClientLink>2</d2p1:ClientLink>
      <d2p1:CustomOptInIdentifier>sample string 48</d2p1:CustomOptInIdentifier>
      <d2p1:CustomOptOutIdentifier>sample string 49</d2p1:CustomOptOutIdentifier>
      <d2p1:Description>sample string 6</d2p1:Description>
      <d2p1:DetailRecordFlagCode>sample string 39</d2p1:DetailRecordFlagCode>
      <d2p1:EndGenerateFileOn>2025-12-30T00:28:54.2887608-05:00</d2p1:EndGenerateFileOn>
      <d2p1:ExportDateFormatNbr>50</d2p1:ExportDateFormatNbr>
      <d2p1:ExportScheduleDateSuffixNbr>8</d2p1:ExportScheduleDateSuffixNbr>
      <d2p1:ExportScheduleFieldDelimiterNbr>20</d2p1:ExportScheduleFieldDelimiterNbr>
      <d2p1:ExportScheduleFileEncodingNbr>46</d2p1:ExportScheduleFileEncodingNbr>
      <d2p1:ExportScheduleLink>1</d2p1:ExportScheduleLink>
      <d2p1:ExportScheduleNewlineDelimiterNbr>21</d2p1:ExportScheduleNewlineDelimiterNbr>
      <d2p1:ExportScheduleNotifications>
        <d2p1:ExportScheduleNotifications>
          <d2p1:Description>sample string 5</d2p1:Description>
          <d2p1:DistributionListLink>3</d2p1:DistributionListLink>
          <d2p1:ExportScheduleRecipientLink>1</d2p1:ExportScheduleRecipientLink>
          <d2p1:ExportScheduleRecipientTypeNbr>2</d2p1:ExportScheduleRecipientTypeNbr>
          <d2p1:Name>sample string 4</d2p1:Name>
        </d2p1:ExportScheduleNotifications>
      </d2p1:ExportScheduleNotifications>
      <d2p1:ExportScheduleOutputFieldSets>
        <d2p1:ExportScheduleOutputFieldSets>
          <d2p1:ExportScheduleOutputFields>
            <d2p1:ExportScheduleOutputFields>
              <d2p1:ActualColumnName>sample string 6</d2p1:ActualColumnName>
              <d2p1:DefaultOrderNumber>8</d2p1:DefaultOrderNumber>
              <d2p1:Description>sample string 7</d2p1:Description>
              <d2p1:DisplayFieldName>sample string 5</d2p1:DisplayFieldName>
              <d2p1:ElementLink>16</d2p1:ElementLink>
              <d2p1:ExportScheduleOutputFieldLink>1</d2p1:ExportScheduleOutputFieldLink>
              <d2p1:GrandParentLink>1</d2p1:GrandParentLink>
              <d2p1:GreatGrandParentLink>1</d2p1:GreatGrandParentLink>
              <d2p1:GreatGreatGrandParentLink>1</d2p1:GreatGreatGrandParentLink>
              <d2p1:Indent>10</d2p1:Indent>
              <d2p1:IsAttributeColumn>true</d2p1:IsAttributeColumn>
              <d2p1:IsFilterHeaderColumn>true</d2p1:IsFilterHeaderColumn>
              <d2p1:IsFilterHeaderPropertyColumn>true</d2p1:IsFilterHeaderPropertyColumn>
              <d2p1:IsProgramColumn>true</d2p1:IsProgramColumn>
              <d2p1:IsProgramPropertyColumn>true</d2p1:IsProgramPropertyColumn>
              <d2p1:OrderNumber>4</d2p1:OrderNumber>
              <d2p1:ParentLink>1</d2p1:ParentLink>
              <d2p1:PropertyLink>17</d2p1:PropertyLink>
              <d2p1:SearchOutputFieldLink>3</d2p1:SearchOutputFieldLink>
              <d2p1:SearchOutputFieldSetLink>2</d2p1:SearchOutputFieldSetLink>
              <d2p1:SearchOutputFieldTypeNbr>9</d2p1:SearchOutputFieldTypeNbr>
            </d2p1:ExportScheduleOutputFields>
          </d2p1:ExportScheduleOutputFields>
          <d2p1:SearchOutputFieldSetLink>1</d2p1:SearchOutputFieldSetLink>
          <d2p1:SearchOutputFormatNbr>2</d2p1:SearchOutputFormatNbr>
        </d2p1:ExportScheduleOutputFieldSets>
      </d2p1:ExportScheduleOutputFieldSets>
      <d2p1:ExportSchedulePeriodNbr>10</d2p1:ExportSchedulePeriodNbr>
      <d2p1:ExportScheduleTimeSuffixNbr>9</d2p1:ExportScheduleTimeSuffixNbr>
      <d2p1:ExportScheduleTypeNbr>14</d2p1:ExportScheduleTypeNbr>
      <d2p1:FileGenerationFailedEmailSubject>sample string 43</d2p1:FileGenerationFailedEmailSubject>
      <d2p1:FileGenerationSuccessfulEmailSubject>sample string 41</d2p1:FileGenerationSuccessfulEmailSubject>
      <d2p1:FileGenerationTime>PT0.1234567S</d2p1:FileGenerationTime>
      <d2p1:FileNameBase>sample string 7</d2p1:FileNameBase>
      <d2p1:FooterRecordFlagCode>sample string 32</d2p1:FooterRecordFlagCode>
      <d2p1:GenerateTimeZoneId>sample string 12</d2p1:GenerateTimeZoneId>
      <d2p1:GenerateTimeZoneUtcOffsetTotalMinutes>13</d2p1:GenerateTimeZoneUtcOffsetTotalMinutes>
      <d2p1:HeaderRecordFlagCode>sample string 26</d2p1:HeaderRecordFlagCode>
      <d2p1:IncludeColumnLabels>true</d2p1:IncludeColumnLabels>
      <d2p1:IncludeFooterDetailRecordCountField>true</d2p1:IncludeFooterDetailRecordCountField>
      <d2p1:IncludeFooterFileTypeField>true</d2p1:IncludeFooterFileTypeField>
      <d2p1:IncludeFooterProcessDateField>true</d2p1:IncludeFooterProcessDateField>
      <d2p1:IncludeFooterProcessTimeField>true</d2p1:IncludeFooterProcessTimeField>
      <d2p1:IncludeFooterRecord>true</d2p1:IncludeFooterRecord>
      <d2p1:IncludeFooterRecordFlagCodeField>true</d2p1:IncludeFooterRecordFlagCodeField>
      <d2p1:IncludeFooterTotalRecordCountField>true</d2p1:IncludeFooterTotalRecordCountField>
      <d2p1:IncludeHeaderChannelIdField>true</d2p1:IncludeHeaderChannelIdField>
      <d2p1:IncludeHeaderFileTypeField>true</d2p1:IncludeHeaderFileTypeField>
      <d2p1:IncludeHeaderProcessDateField>true</d2p1:IncludeHeaderProcessDateField>
      <d2p1:IncludeHeaderProcessTimeField>true</d2p1:IncludeHeaderProcessTimeField>
      <d2p1:IncludeHeaderRecord>true</d2p1:IncludeHeaderRecord>
      <d2p1:IncludeHeaderRecordFlagCodeField>true</d2p1:IncludeHeaderRecordFlagCodeField>
      <d2p1:IncludeHeaderScheduleNameField>true</d2p1:IncludeHeaderScheduleNameField>
      <d2p1:InteractiveDataRetrieval>true</d2p1:InteractiveDataRetrieval>
      <d2p1:IsDeactivated>true</d2p1:IsDeactivated>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:PGPEncryptOutput>true</d2p1:PGPEncryptOutput>
      <d2p1:SFTPDataRetrieval>true</d2p1:SFTPDataRetrieval>
      <d2p1:SFTPFolderName>sample string 18</d2p1:SFTPFolderName>
      <d2p1:SearchLink>3</d2p1:SearchLink>
      <d2p1:SearchOutputFormatNbr>45</d2p1:SearchOutputFormatNbr>
      <d2p1:SegmentGroupName>sample string 5</d2p1:SegmentGroupName>
      <d2p1:SendOnFileGenerationFailed>true</d2p1:SendOnFileGenerationFailed>
      <d2p1:SendOnFileGenerationSuccessful>true</d2p1:SendOnFileGenerationSuccessful>
      <d2p1:UseCustomPreferenceTypeIdentifiers>true</d2p1:UseCustomPreferenceTypeIdentifiers>
    </d2p1:ExportSchedule>
  </ExportSchedules>
</ExportScheduleResult>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

Unauthorized (401)
InternalServerError (500)
BadRequest (400)

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.