Create bulk import. Supported imports are contacts, products and coupons. Content-Type: multipart/form-data

Request

POST https://api.connectif.cloud/imports/

Form parameters

Parameter name Value Description Additional
type string

Type of elements to import. Allowed values are "contacts", "products" and "coupons".

Required
overrideExisting boolean

Option to override existing elements. Will override if true.

Required
updateOnlyEmptyFields boolean

Option to update only empty fields. Will only update fields that are empty if true. Can only be true if overrideExisting is also true.

Required
delimiter string

CSV delimiter. Allowed values are comma (,) and semicolon (;).

Required
couponSetId string

The coupon set identifier to import coupons into. This field is required when import type is coupons.

file file

The file to import. Must be UTF-8 encoded CSV file with content-type text/csv. The CSV file must have headers matching elements fields ids. i.e.: For contacts the field _email is required and other headers names must match contact fields ids.

Required

Authorization

This request requires the use of one of following authorization methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created

Success.

Import
400 Bad Request

Bad request, i.e.: invalid json.

HttpError
401 Unauthorized

Not authorized to access API.

403 Forbidden

Permission not granted to the API Key or account has been blocked.

HttpError
413 Request Entity Too Large

file is too big. Maximum allowed size is 50Mb.

HttpError
415 Unsupported Media Type

Request without multipart/form-data Content-Type header.

HttpError
422 Unprocessable Entity

Resource contains validation errors.

HttpUnprocessableEntityError
429 Too Many Requests

Requests rate limit reached.