Create Customer List

Create a new customer in a customer list.

POST/organizations/{organizationId}/customer-lists/{customerListId}/customers

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Create Customer List action (under Customers (Data API)).
Fill in the fields below, then reference the result from later steps as {{createCustomerList.response.data}}.

Request

Path parameters

customerListIdstringrequired

The customer list ID.

organizationIdstringrequired

An identifier for the organization the request is being made by

Request body

Enter the body as JSON in the step's Body field.

birthdaystring (date)

The customer's birthday.

companyNamestring

The customer's company name.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

credentialsobject

Document representing the credentials of a customer.

enabledboolean

A flag indicating whether the customer is enabled and can log in.

lockedboolean

A flag indicating whether the customer account is locked.

loginstringrequired

The login of the customer.

passwordQuestionstring

The password question.

customerIdstring

The customer's ID. Both registered and guest customers have a customer ID.

customerNostringrequired

The customer's number.

emailstring

The customer's email address.

faxstring

The customer's fax number. The length is restricted to 32 characters.

firstNamestring

The customer's first name.

genderinteger (int32)

The customer's gender.

jobTitlestring

The customer's job title.

lastLoginTimestring (date-time)

The last login time of the customer.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestringrequired

The customer's last name.

lastVisitTimestring (date-time)

The last visit time of the customer.

phoneBusinessstring

The customer's business phone number.

phoneHomestring

The customer's home phone number.

phoneMobilestring

The customer's mobile phone number.

preferredLocalestring

The customer's preferred locale.

previousLoginTimestring (date-time)

The time when the customer previously logged in.

previousVisitTimestring (date-time)

The time when the customer previously visited the store.

primaryAddressobject

Any address that is associated with a customer (billing, shipping, mailing, and so on).

address1string

The customer's first address.

address2string

The customer's second address value.

addressIdstringrequired

The customer address ID.

citystring

The customer's city.

companyNamestring

The customer's company name.

countryCodestringrequired

The customer's two-character country code per ISO 3166-1 alpha-2.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

etagstring

The generated eTag representing the state of the customer address.

firstNamestring

The customer's first name.

fullNamestring

The concatenation of the customer's first, middle, last names, and suffix.

jobTitlestring

The customer's job title.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestringrequired

The customer's last name.

phonestring

The customer's phone number.

postBoxstring

The customer's post box.

postalCodestring

The customer's postal code.

salutationstring

The customer's salutation.

secondNamestring

The customer's second name.

stateCodestring

The customer's state.

suffixstring

The customer's suffix.

suitestring

The customer's suite.

titlestring

The customer's title.

salutationstring

The customer's salutation.

secondNamestring

The customer's second name.

suffixstring

The customer's suffix (for example, "Jr." or "Sr.").

titlestring

The customer's title (for example, "Mrs" or "Mr").

json

{
  "customerNo": "D100201",
  "lastName": "Leung",
  "birthday": "1999-12-31",
  "companyName": "Ursa Major Solar",
  "creationDate": "9999-12-31T00:00:00.0Z",
  "credentials": {
    "login": "wleung",
    "enabled": true,
    "locked": false,
    "passwordQuestion": "Pet Name?"
  },
  "customerId": "wleung",
  "email": "wleung@example.com",
  "fax": "415-555-1213",
  "firstName": "Wei",
  "gender": 2,
  "jobTitle": ""
}

Response

Returns 200 with an object. Read it in later steps with {{createCustomerList.response.data.<field>}}.

birthdaystring (date)

The customer's birthday.

companyNamestring

The customer's company name.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

credentialsobject

Document representing the credentials of a customer.

enabledboolean

A flag indicating whether the customer is enabled and can log in.

lockedboolean

A flag indicating whether the customer account is locked.

loginstringrequired

The login of the customer.

passwordQuestionstring

The password question.

customerIdstring

The customer's ID. Both registered and guest customers have a customer ID.

customerNostring

The customer's number.

emailstring

The customer's email address.

faxstring

The customer's fax number. The length is restricted to 32 characters.

firstNamestring

The customer's first name.

genderinteger (int32)

The customer's gender.

jobTitlestring

The customer's job title.

lastLoginTimestring (date-time)

The last login time of the customer.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestring

The customer's last name.

lastVisitTimestring (date-time)

The last visit time of the customer.

phoneBusinessstring

The customer's business phone number.

phoneHomestring

The customer's home phone number.

phoneMobilestring

The customer's mobile phone number.

preferredLocalestring

The customer's preferred locale.

previousLoginTimestring (date-time)

The time when the customer previously logged in.

previousVisitTimestring (date-time)

The time when the customer previously visited the store.

primaryAddressobject

Any address that is associated with a customer (billing, shipping, mailing, and so on).

address1string

The customer's first address.

address2string

The customer's second address value.

addressIdstringrequired

The customer address ID.

citystring

The customer's city.

companyNamestring

The customer's company name.

countryCodestringrequired

The customer's two-character country code per ISO 3166-1 alpha-2.

creationDatestring (date-time)

Returns the value of attribute 'creationDate'.

etagstring

The generated eTag representing the state of the customer address.

firstNamestring

The customer's first name.

fullNamestring

The concatenation of the customer's first, middle, last names, and suffix.

jobTitlestring

The customer's job title.

lastModifiedstring (date-time)

Returns the value of attribute 'lastModified'.

lastNamestringrequired

The customer's last name.

phonestring

The customer's phone number.

postBoxstring

The customer's post box.

postalCodestring

The customer's postal code.

salutationstring

The customer's salutation.

secondNamestring

The customer's second name.

stateCodestring

The customer's state.

suffixstring

The customer's suffix.

suitestring

The customer's suite.

titlestring

The customer's title.

salutationstring

The customer's salutation.

secondNamestring

The customer's second name.

suffixstring

The customer's suffix (for example, "Jr." or "Sr.").

titlestring

The customer's title (for example, "Mrs" or "Mr").

json

{
  "customerNo": "D100201",
  "lastName": "Leung",
  "birthday": "1999-12-31",
  "companyName": "Ursa Major Solar",
  "creationDate": "9999-12-31T00:00:00.0Z",
  "credentials": {
    "login": "wleung",
    "enabled": true,
    "locked": false,
    "passwordQuestion": "Pet Name?"
  },
  "customerId": "wleung",
  "email": "wleung@example.com",
  "fax": "415-555-1213",
  "firstName": "Wei",
  "gender": 2,
  "jobTitle": ""
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?