Request profile import

Request a profile import into APSIS One.

Import is an asynchronous operation. Once it's been requested you'll receive a response that contains the file upload URL with embedded credentials and the expiration details.

Upload your import file using that URL. APSIS One API profile import supports CSV files (content type text/csv).

In its requests and responses, APSIS One API supports date and time formatted as ISO 8601 referred to as date-time in RFC 3339, section 5.6 in the UTC variant.

Import files support more date formats as described in this Help Center article. However these dates will be converted to a format corresponding to the type of the attribute the import file column is mapped to. Read more about attribute types in this Help Center article.

Once you've uploaded the file you can check the status using the corresponding GET /audience/sections/{section_discriminator}/imports/{import_id} endpoint.

The manage_subscriptions flag must be true on the keyspace used or HTTP 403 Forbidden response status code is returned.

All the attributes and tags you are trying to set during the import need to be allowed to WRITE through the selected keyspace. If any of them is not, HTTP 403 Forbidden response status code is returned.

Limits

The maximum import file size is 50 MB. Split your import into multiple files and import requests to mitigate this.

Pending import count limit. If reached, HTTP 429 Too Many Requests is returned.

The import file considerations are the same when importing via APSIS One as when importing via this API. They've been described in this Knowledge Base article.

Understanding import failures

For every import, we're generating a report that contains statistics and detailed information about the import errors. See this Knowledge Base article.

Deprecated

Use version 2 instead.

Historically, this endpoint supports creating profile keys in multiple keyspace with one request by adding more than one object inside the keyspace_mappings request body parameter. We're moving away from this behavior in profile imports. When channel-specific topics are enabled on your account, this endpoint no longer supports creating multiple profile keys anymore. A request with multiple keyspace_mappings is rejected with the HTTP 400 Bad Request response status code. In rare cases when multiple profile keys are required, request multiple imports for your profiles.

Inside consent_mappings, for channel-specific topics the channel_discriminator parameter must correspond to the topic_discriminator parameter

Version 2 of the Profile Import feature does not use address_field_selector. Consents are created using the addresses mapped to the Email or Mobile attributes, depending on the consent channel.

Changes in Consent 2.0

In Consent 2.0 consent list discriminator is not required anymore and a consent is given on the profile level (and not the address level) so the consent_list_discriminator request parameter is now deprecated

See this page to understand how to proceed with your existing and new integrations

More information

Step by step guide

Language
Authorization
Bearer
JWT
URL