INinfomaniak
Subscribers

Import subscribers

Import subscribers from a upload id.

If replace_fields is true (default), replace the values of the custom fields provided in the mapping. Custom fields absent from the file keep their existing values, and a provided field with an empty value is cleared.

post/1/newsletters/{domain}/subscribers/import

Request

  • Base URL
    https://api.infomaniak.com
  • URL
    https://api.infomaniak.com/1/newsletters/{domain}/subscribers/import
  • Auth
    none declared

Path parameters

domainstring required

Request body

csv_enclosurestring
csv_separatorstring
fieldsstring[] required

Object keys must correspond to field's id (integer), or its description (type + name).

groupsstring[]

An array of valid identifiers or the names of groups to be created.

ipd_uuidstring
replace_fieldsboolean
upload_idinteger

Example request

{
  "fields": [
    "{\"type\": \"str\",\"name\": \"enterprise\"}"
  ]
}

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this operation across all 40 revisions of this API.