Kustomer API

Getting access, Developing, Testing

Back to Kustomer

Bulk Batch Update Companies

Batch update multiple companies with this action.

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

|Legacy Role|Equivalent Permission Set Role| |-----|--------| |org.user.company.write|org.permission.company.update|

Custom Attributes

Custom attributes are optional and allow you to specify custom key value pairs. They follow a convention which allows us to specify the field data type with a name suffix:

Suffix
  • Num or null
  • At or null
  • Str or null, length: [ 0 .. 1024 ] characters
  • Txt or null, length: [ 0 .. 1024 ] characters
  • Bool or null
  • Url or null, format:

Input

type: object properties: data: type: string example: >- "[\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"avatarUrl\": \"<uri>\",\n \"emails\": [\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 \"socials\": [\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 \"domains\": [\n {\n \"domain\": \"<domain-name>\"\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 \"employeeCount\": \"<number>\",\n \"tags\": [\n \"<string>\"\n ],\n \"custom\": \"<object>\",\n \"defaultLang\": \"<string>\",\n \"deleted\": \"<boolean>\"\n },\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"externalId\": \"<string>\",\n \"avatarUrl\": \"<uri>\",\n \"emails\": [\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 \"socials\": [\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 \"domains\": [\n {\n \"domain\": \"<domain-name>\"\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 \"employeeCount\": \"<number>\",\n \"tags\": [\n \"<string>\"\n ],\n \"custom\": \"<object>\",\n \"defaultLang\": \"<string>\",\n \"deleted\": \"<boolean>\"\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: id: type: string 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