Skip to content

Add Profile Key

customerprofiles_add_profile_key R Documentation

Associates a new key value with a specific profile, such as a Contact Record ContactId

Description

Associates a new key value with a specific profile, such as a Contact Record ContactId.

A profile object can have a single unique key and any number of additional keys that can be used to identify the profile that it belongs to.

Usage

customerprofiles_add_profile_key(ProfileId, KeyName, Values, DomainName)

Arguments

ProfileId

[required] The unique identifier of a customer profile.

KeyName

[required] A searchable identifier of a customer profile. The predefined keys you can use include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

Values

[required] A list of key values.

DomainName

[required] The unique name of the domain.

Value

A list with the following syntax:

list(
  KeyName = "string",
  Values = list(
    "string"
  )
)

Request syntax

svc$add_profile_key(
  ProfileId = "string",
  KeyName = "string",
  Values = list(
    "string"
  ),
  DomainName = "string"
)