POST Async/{clientId}/Import
Initiates a bulk import
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
Name | Description | Type | Additional information |
---|---|---|---|
Name |
The name of the bulk import |
string |
Required Max length: 100 Min length: 1 |
DataStageDuration |
Determines the number of days for retaining the staged data before deleting it. If not specified, the default is 3 days. The DataStageDuration cannot exceed 10 days. |
integer |
Range: inclusive between 0 and 10 |
MatchCriteria |
Criteria used to lookup and update a Profile |
string | |
MatchValue |
Value used to lookup and update a Profile |
string | |
RefreshAlternateIds |
If true, existing AlternateIds that are NOT included in the import, will be deactivated. Defaults to false |
boolean | |
RefreshContacts |
If true, existing profile contact elements that are NOT included in the import, will be deactivated along with any preferences associated with them. Defaults to false |
boolean | |
RefreshCustomFields |
If true, existing CustomFields that are NOT included in the import, will be deleted. Defaults to false |
boolean | |
RefreshGroups |
If true, existing Groups that are NOT included in the import, will be deactivated. Defaults to false |
boolean | |
RefreshTags |
If true, existing Tags that are NOT included in the import, will be deleted. Defaults to false |
boolean |
Request Formats
application/json, text/json, application/json-patch+json
{ "Name": "sample string 1", "DataStageDuration": 2, "MatchCriteria": "sample string 3", "MatchValue": "sample string 4", "RefreshAlternateIds": true, "RefreshContacts": true, "RefreshCustomFields": true, "RefreshGroups": true, "RefreshTags": true }
application/xml, text/xml
<InitiateBulkImport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models.Import"> <DataStageDuration>2</DataStageDuration> <MatchCriteria>sample string 3</MatchCriteria> <MatchValue>sample string 4</MatchValue> <Name>sample string 1</Name> <RefreshAlternateIds>true</RefreshAlternateIds> <RefreshContacts>true</RefreshContacts> <RefreshCustomFields>true</RefreshCustomFields> <RefreshGroups>true</RefreshGroups> <RefreshTags>true</RefreshTags> </InitiateBulkImport>
Response Information
Response Codes
HTTP Status Code | Text | Description |
---|---|---|
200 | OK | The request was successfully processed. |
400 | Bad Request | The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again. |
401 | Unauthorized | Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again. |
403 | Forbidden | The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again. |
404 | Not Found | The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details. |
500 | Internal Server Error | The server encountered an unexpected condition that prevented it from fulfilling the request. Notify PossibleNOW Support if it’s a continuous occurrence. |
Resource Description
InitiateBulkImportResponseName | Description | Type | Additional information |
---|---|---|---|
AccessToken |
Token used to stage, execute, and retrieve import status and failed records |
integer | |
Status |
The Status of the import. "Initiated", "Staging", "Queued", "Processing", "Completed", or "Failed" |
string | |
Expires |
Date the access token expires |
string | |
Name |
The name of the bulk import |
string |
Required Max length: 100 Min length: 1 |
DataStageDuration |
Determines the number of days for retaining the staged data before deleting it. If not specified, the default is 3 days. The DataStageDuration cannot exceed 10 days. |
integer |
Range: inclusive between 0 and 10 |
MatchCriteria |
Criteria used to lookup and update a Profile |
string | |
MatchValue |
Value used to lookup and update a Profile |
string | |
RefreshAlternateIds |
If true, existing AlternateIds that are NOT included in the import, will be deactivated. Defaults to false |
boolean | |
RefreshContacts |
If true, existing profile contact elements that are NOT included in the import, will be deactivated along with any preferences associated with them. Defaults to false |
boolean | |
RefreshCustomFields |
If true, existing CustomFields that are NOT included in the import, will be deleted. Defaults to false |
boolean | |
RefreshGroups |
If true, existing Groups that are NOT included in the import, will be deactivated. Defaults to false |
boolean | |
RefreshTags |
If true, existing Tags that are NOT included in the import, will be deleted. Defaults to false |
boolean |
Response Formats
application/json, text/json, application/json-patch+json
{ "AccessToken": 1, "Status": "sample string 2", "Expires": "sample string 3", "Name": "sample string 4", "DataStageDuration": 5, "MatchCriteria": "sample string 6", "MatchValue": "sample string 7", "RefreshAlternateIds": true, "RefreshContacts": true, "RefreshCustomFields": true, "RefreshGroups": true, "RefreshTags": true }
application/xml, text/xml
<InitiateBulkImportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProfileServices.REST.Models.Import"> <DataStageDuration>5</DataStageDuration> <MatchCriteria>sample string 6</MatchCriteria> <MatchValue>sample string 7</MatchValue> <Name>sample string 4</Name> <RefreshAlternateIds>true</RefreshAlternateIds> <RefreshContacts>true</RefreshContacts> <RefreshCustomFields>true</RefreshCustomFields> <RefreshGroups>true</RefreshGroups> <RefreshTags>true</RefreshTags> <AccessToken>1</AccessToken> <Expires>sample string 3</Expires> <Status>sample string 2</Status> </InitiateBulkImportResponse>