POST /crm/channel/{channelLinkId}/customers

Headers

  • Accept string Required

Path parameters

  • channelLinkId string Required

    Channel link ID

application/json

Body Required

  • contact object
    Hide contact attributes Show contact attributes object
    • email string
    • firstName string
    • lastName string
    • birthdate string
    • phone string
  • externalId string
  • loyaltyProviderId string
  • deliveryAddresses array[object]
    Hide deliveryAddresses attributes Show deliveryAddresses attributes object
    • country string
    • stateOrProvince string
    • city string
    • streetName string
    • postalCode string
    • houseNumber string
    • default string
  • billingAddress object
    Hide billingAddress attributes Show billingAddress attributes object
    • country string
    • stateOrProvince string
    • city string
    • streetName string
    • postalCode string
    • houseNumber string
  • metadata object
  • vehicles array[object]
    Hide vehicles attributes Show vehicles attributes object
    • make string
    • model string
    • color string
    • default string

Responses

  • 201 application/json

    Created

    Hide response attributes Show response attributes object
    • id string
    • contact object
      Hide contact attributes Show contact attributes object
      • email string
      • firstName string
      • lastName string
      • phone object
      • fullName string
POST /crm/channel/{channelLinkId}/customers 
curl \
 --request POST 'https://api.staging.deliverect.com/crm/channel/{channelLinkId}/customers' \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --data '{"contact":{"email":"{email}","firstName":"{firstName}","lastName":"{lastName}","birthdate":"{birthdate}","phone":"{phone}"},"externalId":"{externalId}","loyaltyProviderId":"{loyaltyProviderId}","deliveryAddresses":[{"country":"{countryCode}","stateOrProvince":"{stateOrProvince}","city":"{city}","streetName":"{streetName}","postalCode":"{postalCode}","houseNumber":"{houseNumber}","default":"{isDefaultDeliveryAddress1}"},{"country":"{countryCode2}","stateOrProvince":"{stateOrProvince2}","city":"{city2}","streetName":"{streetName2}","postalCode":"{postalCode2}","houseNumber":"{houseNumber2}","default":"{isDefaultDeliveryAddress2}"}],"billingAddress":{"country":"{billingCountryCode}","stateOrProvince":"{billingStateOrProvince}","city":"{billingCity}","streetName":"{billingStreetName}","postalCode":"{billingPostalCode}","houseNumber":"{billingHouseNumber}"},"metadata":{},"vehicles":[{"make":"{vehicleMake1}","model":"{vehicleModel1}","color":"{vehicleColor1}","default":"{isDefaultVehicle1}"},{"make":"{vehicleMake2}","model":"{vehicleModel2}","color":"{vehicleColor2}","default":"{isDefaultVehicle2}"}]}'
Request example 
{
  "contact": {
    "email": "{email}",
    "firstName": "{firstName}",
    "lastName": "{lastName}",
    "birthdate": "{birthdate}",
    "phone": "{phone}"
  },
  "externalId": "{externalId}",
  "loyaltyProviderId": "{loyaltyProviderId}",
  "deliveryAddresses": [
    {
      "country": "{countryCode}",
      "stateOrProvince": "{stateOrProvince}",
      "city": "{city}",
      "streetName": "{streetName}",
      "postalCode": "{postalCode}",
      "houseNumber": "{houseNumber}",
      "default": "{isDefaultDeliveryAddress1}"
    },
    {
      "country": "{countryCode2}",
      "stateOrProvince": "{stateOrProvince2}",
      "city": "{city2}",
      "streetName": "{streetName2}",
      "postalCode": "{postalCode2}",
      "houseNumber": "{houseNumber2}",
      "default": "{isDefaultDeliveryAddress2}"
    }
  ],
  "billingAddress": {
    "country": "{billingCountryCode}",
    "stateOrProvince": "{billingStateOrProvince}",
    "city": "{billingCity}",
    "streetName": "{billingStreetName}",
    "postalCode": "{billingPostalCode}",
    "houseNumber": "{billingHouseNumber}"
  },
  "metadata": {},
  "vehicles": [
    {
      "make": "{vehicleMake1}",
      "model": "{vehicleModel1}",
      "color": "{vehicleColor1}",
      "default": "{isDefaultVehicle1}"
    },
    {
      "make": "{vehicleMake2}",
      "model": "{vehicleModel2}",
      "color": "{vehicleColor2}",
      "default": "{isDefaultVehicle2}"
    }
  ]
}
Response examples (201) 
{
  "id": "6916331312c63ca1f6cca94b",
  "contact": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "phone": null,
    "fullName": "John Doe"
  }
}