Bulk Import of Points of Contact
Method Description
Invoked with a POST request. Request address is set up via Maestra framework.
POST https://api.maestra.io/v3/operations/bulk?endpointId={API endpoint ID}&operation=DirectCrm.PointsOfContacts.Import&csvCodePage=65001
HTTP/1.1
Authorization: SecretKey {Secret Key}
Accept: application/xml
Content-Type: text/csv
- csvCodePage: Windows codepage ID for CSV file. 65001 (UTF-8) is preferred.
- csvColumnDelimiter: Column delimiter symbol in CSV file.
- csvTextQualifier: Optional start/end character in column value, masking otherwise invalid characters.
- Authorization key: The value is obtained via Maestra.
- The service allows up to 60 imports per hour. When this limit is exceeded, you’ll receive 429 Too Many Requests until the ratio of tasks queued/hour drops below 60.
Field Descriptions
Title | Description |
---|---|
ExternalId | Point of contact ID (store, site, etc.). For example, "ShopTverskaya9" |
Name | Point of contact name. For example, "Store at Tverskaya 9" |
Comment | Point of contact description |
ParentChannelExternalId | Channel ID which the point of contact belongs to. Channels are used to establish an hierarchy, for example region > city > store. |
CustomFieldAddress | Custom point of contact field. Names and number of custom fields vary by project. Check with the Maestra manager. |
Sample Request
POST https://api.maestra.io/v3/operations/bulk?endpointId=Maestra&operation=DirectCrm.PointsOfContacts.Import&suppressAllWarnings=true&csvCodePage=65001&csvColumnDelimiter=%3B&csvTextQualifier=%22
Authorization: SecretKey VRY294
Accept: application/xml
Content-Type: text/csv
ExternalId;Name;Comment;ParentChannelExternalId;CustomFieldAddress
115;Fifth Avenue;First store in NYC!;15;NYC, Fifth Avenue
Updated about 1 month ago