Add Account Contact List

Creates a new CustomerContacts for a customer account in bulk to support adding multiple contacts in a multi-ship scenario.

PUT /commerce/customer/accounts/{accountId}/contacts

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "accountId": 123,
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "addressType": "<string>",
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "faxNumber": "<string>",
      "firstName": "<string>",
      "id": 123,
      "label": "<string>",
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "types": [
        {
          "isPrimary": true,
          "name": "<string>"
        }
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

accountId · integer<int32> · required

Unique identifier of the customer account to contain the new CustomerContact.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

List of CustomerContact objects : Properties of each new CustomerContact. Required properties: CustomerContact.Email, ContactType.

accountId · integer<int32>

address · object

Show child attributes

auditInfo · object

Show child attributes

companyOrOrganization · string | null

email · string | null

faxNumber · string | null

firstName · string | null

id · integer<int32> | null

label · string | null

lastNameOrSurname · string | null

middleNameOrInitial · string | null

phoneNumbers · object

Show child attributes

types · object[] | null

Show child attributes

Response

200

application/json

Success

Collection of contacts returned as a whole.

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>