Sign in

v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Contacts

Add/update contacts from external file

The method is used to import or update the contacts from an external file. The method creates new contacts and updates existing ones.

post/api/v1/contacts/upload

Request body

dedupeOn'email' | 'sms' | 'email_or_sms' | 'id' required

The property for determining the contact uniqueness.

linkstring required

The link to a file in an external repository.</br> <b>File Requirements:</b><br/> Not empty<br/> Delimiters - ","<br/> Maximum size 100 MB <br/> <b>Requirement for column naming:</b><br/> First name. The following rules apply to character usage:<br/>

  • Max length: 40 symbols. <br>- Letters from any alphabet are allowed (Unicode characters). <br>- Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. <br>- Up to 3 digits are allowed. <br>- Special characters are not allowed, except for: <br>-- Apostrophes ''ʼ`´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ＇ (only inside words) <br>-- Hyphen - (only inside words) <br>-- One dot at the end of words having max 3 characters. Example: Jr. <br>- Names consisting only of numbers and special characters are not allowed <br> Last name. The following rules apply to character usage:<br/>
  • Max length: 40 symbols. <br>- Letters from any alphabet are allowed (Unicode characters). <br>- Three words longer than 3 characters and three words with a maximum of 3 characters are allowed. <br>- Up to 3 digits are allowed. <br>- Special characters are not allowed, except for: <br>-- Apostrophes ''ʼ`´ʹʻʽʾʿˈˊˮʹ΄՚᾽᾿'‛′‵Ꞌꞌ＇ (only inside words) <br>-- Hyphen - (only inside words) <br>-- One dot at the end of words having max 3 characters. Example: Jr. <br>- Names consisting only of numbers and special characters are not allowed <br> Address<br/> Country<br/> Region<br/> City<br/> Postcode<br/> Email<br/> SMS<br/> Language code<br/> Timezone<br/> Contact ID<br/> Additional info<br/> The columns containing additional contact fields in a file shall be named: KEY_PROFILE.KEY_CUSTOMFIELD<br/> The fields that are not found in the system remain empty (not updated).
groupNamesstring[]

The list of segment names where new/updated contacts will be added to.

groupNamesExcludestring[]

The list of segment names where new/updated contacts will be excluded from.

restoreDeletedboolean

Add previously deleted contacts.

eventKeyForNewContactsstring

Event type identification key. An event of corresponding type is generated for each contact. <br> If the system does not have an event type with such a key, a new event type is created. <br> All characters are allowed, except < ; ’ \ / | " ` ' ^ ? ! , > <br> Max length: 100 symbols

Example request

{
  "link": "https://github.com/example-user/example-repo/blob/main/example-file.txt",
  "eventKeyForNewContacts": "newContactweb"
}