Bulk Import of Customers
Method Description
Invoked with a POST request. Request address and input fields can be set up via Maestra framework.
POST https://api.maestra.io/v3/operations/bulk?endpointId={API endpoint ID}&operation=DirectCrm.Customers.Import&brand={Brand}&csvCodePage=65001&csvColumnDelimiter=%3B&csvTextQualifier=%22&SourceActionTemplate={Customer Sign-Up Action}
HTTP/1.1
Authorization: Basic {authorization key}
Accept: application/xml
Content-Type: text/csv
- csvCodePage: Windows codepage ID for CSV file. 65001 (UTF-8) is preferred.
- csvColumnDelimiter: Column delimiter character in CSV file.
- csvTextQualifier: Optional start/end character in column value, masking otherwise invalid characters.
- brand: Brand which the customers belong to. The value is set up in the system.
- SourceActionTemplate: Customer sign-up action. For example: "Website Sign-Up" or "Form Submitted In-Store". The value is set up in the system.
- Authorization key: The value is set up in the system.
- The service allows up to 60 imports per hour. If the limit is exceeded, you’ll receive 429 Too Many Requests until the ratio of tasks queued/hour drops below 60.
Field Descriptions
Title | Description |
---|---|
Websiteid | Customer website ID |
FirstName | Customer first name |
LastName | Customer last name |
MiddleName | Customer middle name |
MobilePhone | Mobile phone |
Customer email | |
BirthDate | Date of birth as yyyy-MM-dd |
SourceDateTime | Sign-up date and time as yyyy-MM-dd HH:mm:ss, project time |
SourcePointOfContact | Sign-up point of contact, for example 'Site' or 'Tverskaya Store' |
IsSubscribed | Subscription status, true or false |
Optional Customer Field | Optional customer field value |
Sample Request
POST https://api.maestra.io/v3/operations/bulk?endpointId=Maestra&operation=DirectCrm.Customers.Import&brand=Maestra&csvCodePage=65001&csvColumnDelimiter=%3B&csvTextQualifier=%22&SourceActionTemplate=ZaregistrirovalsyaVLoyalnosti
Authorization: Basic bWFuemFuuYTowcXY3ODMuzNjI2M3EzT0Y=
Accept: application/xml
Content-Type: text/csv
Email;balance;BirthDate;SourceDateTime;Region;SourcePointOfContact;LastName;FirstName;MiddleName;IsSubscribed
[email protected];433;12.04.1982;16.04.2016 21:00;711;727;Smith;Mary;Ann;1
[email protected];324;16.01.1980;16.04.2016 21:00;714;727;Smith;John;Michael;1
Updated about 1 month ago