Importing Custom Field Values

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.CustomFieldEnumValues.Import&customFieldKindSystemName={Custom field system name}&customFieldKindEntityType={Custom field entity type}&csvCodePage=65001
HTTP/1.1

Authorization: SecretKey {Secret Key}
Accept: application/xml
Content-Type: text/csv
  • customFieldKindSystemName: Custom field system name
  • customFieldKindEntityType - Custom field entity type:
    — HC - Customer
    — ProductInfo - Product
    — AR - Area
    — DC - Discount Card
    — CA - Customer Action
    — RO - Order
    — RP - Order Line
    — RLP - Product List Item
    — POC - Touchpoint
  • 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

TitleDescription
ExternalIdValue transfer option ID
ValueValue transfer option

Sample Request

POST https://api.maestra.io/v3/operations/bulk?endpointId=Maestra&operation=DirectCrm.CustomFieldEnumValues.Import&customFieldKindSystemName=CustomStatus&suppressAllWarnings=true&csvCodePage=65001&csvColumnDelimiter=%3B&csvTextQualifier=%22

Authorization: SecretKey mDdO
Accept: application/xml
Content-Type: text/csv


ExternalId;Value
SilverStatus;Silver Status
GoldStatus;Gold Status