Retrieve status
Use this method to retrieve the current status of an import. One of the following statuses will be returned.
- Initiated - The import has been defined and is ready to accept profile records.
- Staging - The data is being staged. More records may be added at this stage.
- Queued - The import has been executed and records have been queued.
- Processing - The records are being processed.
- Completed - The records have been imported.
- Failed - The import has failed to execute and none of the staged records were added into MyPreferences.
Header Parameters
Authorization token
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Access token returned from InitiateBulkImport call. A 401 is returned if this value is invalid.
Response
Response Attributes
Total number of records that were staged. This number is the combined value of all of the records that were added during the staging phase of the import.
Total Number of records that were validated successfully during the staging phase and are ready for execution. This number is the combined value of all records submitted across various requests during the staging phase of the import.
Number of records that failed validation during the staging process. Any records that fail validation will not be imported during the execution phase.
Number of records that have been imported into MyPreferences. During the staging process, this value will always return 0.
Total amount of records that have been marked as pending to be processed during the staging phase. This number is the combined value of all of the requests that were received during the staging phase of the import.
Total number of records that encountered exceptions during the import execution. During the staging process, this value will always return 0.
Number of records that were not honored by the system during the import process. During the staging process, this value will always return 0.
Token created by the initiate method used to stage, execute, and retrieve import status and failed records.
Returns the current state of the import. 'Initiated', 'Staging', 'Queued', 'Processing', 'Completed', or 'Failed'.
Date when the access token will expire. Default expiration time is 12 hours.
Name associated with the bulk import operation.
Determines the number of days for retaining staged data before it is permanently deleted. If not specified, it defaults to 3 days. The staging duration cannot exceed 10 days.
An optional parameter that can be used as a matching identifier in the absence of a Profile ID. Currently, AlternateIdType is the only supported match criteria.
TypeName associated with the match criteria. Specify the name of an AlternateIdType configured in your account since AlternateIdType is the only supported Match Criteria.
If set to true, existing AlternateIds that are NOT included in the import will be deactivated. Default value is false.
If set to true, existing profile contact elements that are NOT included in the import will be deactivated along with any preferences associated with them. Default value is false.
If set to true, existing CustomFields that are NOT included in the import will be deleted. Default value is false.
If set to true, existing Groups that are NOT included in the import, will be deactivated. Default value is false.
If set to true, existing Tags that are NOT included in the import, will be deleted. Default value is false.
A boolean flag, when set to true, permits adding an older version of a consent to the profile, provided that a more recent version of the consent is not already present.
What made this section unhelpful for you?
Response
What made this section unhelpful for you?