Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Bulk Create Customers

Create customers in bulk.

Any one of the following roles is required for this endpoint:

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.customer.write|org.permission.customer.create|

Input

type: object properties: data: type: string example: >- "[\n {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"externalId\": \"<string>\",\n \"username\": \"<string>\",\n \"signedUpAt\": \"<dateTime>\",\n \"lastActivityAt\": \"<dateTime>\",\n \"lastCustomerActivityAt\": \"<dateTime>\",\n \"lastSeenAt\": \"<dateTime>\",\n \"avatarUrl\": \"<uri>\",\n \"externalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedExternalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedEmails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedPhones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"whatsapps\": [\n {\n \"phone\": \"<whatsapp-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"facebookIds\": [\n {\n \"pageId\": \"<string>\",\n \"userId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"instagramIds\": [\n {\n \"pageId\": \"<string>\",\n \"threadId\": \"<string>\",\n \"username\": \"<string>\",\n \"instagramId\": \"<string>\"\n }\n ],\n \"socials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedSocials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"<url>\",\n \"type\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"latitude\": \"<number>\",\n \"longitude\": \"<number>\",\n \"countryCode\": \"<string>\",\n \"countryName\": \"<string>\",\n \"regionCode\": \"<string>\",\n \"regionName\": \"<string>\",\n \"cityName\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"areaCode\": \"<string>\"\n }\n ],\n \"locale\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"sentiment\": {\n \"polarity\": \"<number>\",\n \"confidence\": \"<number>\"\n },\n \"custom\": \"<object>\",\n \"birthdayAt\": \"<dateTime>\",\n \"gender\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"importedAt\": \"<dateTime>\",\n \"rev\": \"<number>\",\n \"defaultLang\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"company\": \"<string>\",\n \"externalId\": \"<string>\",\n \"username\": \"<string>\",\n \"signedUpAt\": \"<dateTime>\",\n \"lastActivityAt\": \"<dateTime>\",\n \"lastCustomerActivityAt\": \"<dateTime>\",\n \"lastSeenAt\": \"<dateTime>\",\n \"avatarUrl\": \"<uri>\",\n \"externalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedExternalIds\": [\n {\n \"externalId\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"emails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedEmails\": [\n {\n \"email\": \"<email-relaxed>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"phones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedPhones\": [\n {\n \"phone\": \"<phone-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"whatsapps\": [\n {\n \"phone\": \"<whatsapp-number>\",\n \"type\": \"<string>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"facebookIds\": [\n {\n \"pageId\": \"<string>\",\n \"userId\": \"<string>\",\n \"name\": \"<string>\"\n }\n ],\n \"instagramIds\": [\n {\n \"pageId\": \"<string>\",\n \"threadId\": \"<string>\",\n \"username\": \"<string>\",\n \"instagramId\": \"<string>\"\n }\n ],\n \"socials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"sharedSocials\": [\n {\n \"type\": \"<string>\",\n \"username\": \"<string>\",\n \"userid\": \"<string>\",\n \"url\": \"<uri>\",\n \"verified\": \"<boolean>\"\n }\n ],\n \"urls\": [\n {\n \"url\": \"<url>\",\n \"type\": \"<string>\"\n }\n ],\n \"locations\": [\n {\n \"type\": \"<string>\",\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"address2\": \"<string>\",\n \"address3\": \"<string>\",\n \"latitude\": \"<number>\",\n \"longitude\": \"<number>\",\n \"countryCode\": \"<string>\",\n \"countryName\": \"<string>\",\n \"regionCode\": \"<string>\",\n \"regionName\": \"<string>\",\n \"cityName\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"areaCode\": \"<string>\"\n }\n ],\n \"locale\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"sentiment\": {\n \"polarity\": \"<number>\",\n \"confidence\": \"<number>\"\n },\n \"custom\": \"<object>\",\n \"birthdayAt\": \"<dateTime>\",\n \"gender\": \"<string>\",\n \"createdAt\": \"<dateTime>\",\n \"importedAt\": \"<dateTime>\",\n \"rev\": \"<number>\",\n \"defaultLang\": \"<string>\"\n }\n]" title: Data

Output

type: object properties: data: type: object properties: type: type: string id: type: string attributes: type: object properties: ids: type: string context: type: string status: type: string v2: type: string payload: type: object properties: api: type: object properties: data: type: array items: type: object properties: name: type: string path: type: string user: type: object properties: id: type: string userType: type: string roles: type: array items: type: string orgName: type: string subject: type: string org: type: string requestId: type: string service: type: string method: type: string createdAt: type: string updatedAt: type: string completed: type: string relationships: type: object properties: org: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string createdBy: type: object properties: links: type: object properties: self: type: string data: type: object properties: type: type: string id: type: string links: type: object properties: self: type: string