Skip to main content

Communication methods

Manage the communication methods on an existing consumer profile, such as email and phone number, using the Consumer Profile Management API. You can store multiple communication methods in a consumer profile. 

Supported communication methods:

  • Email ID
  • Phone number

Add a communication method to a consumer profile

You can add a new communication method to an existing consumer profile by sending a POST request to the /consumer-profiles/{consumer-profile-id}/communication endpoint.

HTTP method: POST

Endpoint: /consumer-profiles/PACJGQ/communication

Scenario: Adding a new communication method to the consumer profile with consumer-profile-id = PACJGQ

Json
{
    "phoneList": [
        {
            "phoneNumber": "8888888828",
            "countryCode": "1",
            "phoneNumberType": "Home"
        }
    ],
    "emailList": [
        {
            "emailAddress": "john.doe.x@gmail.com",
            "emailAddressType": "Home"
        }
    ]
}

Response:

Json
{
    "consumerProfileId": "PACJGQ",
    "cardOnFileReferenceNumber": "",
    "firstName": "John",
    "lastName": "Doe",
    "communication": {
        "phoneList": [
            {
                "phoneNumber": "8888888828",
                "countryCode": "1",
                "phoneNumberType": "Home",
                "communicationIdentifier": "HH04423498968"
            }
        ],
        "emailList": [
            {
                "emailAddress": "john.doe.x@gmail.com",
                "emailAddressType": "Home",
                "communicationIdentifier": "EE8141240230923"
            }
        ]
    },
    "paymentMethodType": {
        "cardList": [
            {
                "paymentMethodId": "77ccba29-4857-494a-82bc-2a80e1fa2b9d",
                "cardExpirationMonthYearNumber": "02/2025",
                "last4CardNumber": "2234",
                "accountStatus": "ACTIVE",
                "cardType": "MC",
                "firstName": "John",
                "lastName": "Doe",
                "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0"
            }
        ]
    },
    "addresses": [
        {
            "addressIdentifier": "8d452494-ec75-4ef9-9b45-e4bd7debf6a0",
            "firstName": "John",
            "lastName": "Doe",
            "consumerAssignedAddressName": "Work2",
            "primaryAddressIndicator": true,
            "addressType": "SHIPPING",
            "line1": "200 Elton Farm",
            "line2": "Apt 123",
            "city": "Glen Mills",
            "state": "PA",
            "postalCode": "19342",
            "countryCode": "USA",
            "addressStatus": "ACTIVE"
        }
    ],
    "correlationIdentifier": "c1143783-8c2a-43c8-84ee-2893c2e53e89",
    "createTimestamp": "2024-07-02T09:55:18.996Z",
    "createUserIdentifier": "jack",
    "updateTimestamp": "2024-07-02T09:55:18.996Z",
    "updateUserIdentifier": "jack",
    "profileStatus": "ACTIVE"
}

Manage communication methods on a consumer profile

You can manage the communication methods on a consumer profile using the following actions:

  1. Add a communication method to a consumer profile
  2. Update a communication method
  3. Set the default communication method
  4. Delete a communication method

To learn more about how to manage communication methods, refer to Manage communication methods for a consumer profile.

Manage addresses for a consumer profile address
Manage payment methods for a consumer profile
Manage communication methods for a consumer profile