Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data AddProfileKey = AddProfileKey' {}
- newAddProfileKey :: Text -> Text -> Text -> AddProfileKey
- addProfileKey_profileId :: Lens' AddProfileKey Text
- addProfileKey_keyName :: Lens' AddProfileKey Text
- addProfileKey_values :: Lens' AddProfileKey [Text]
- addProfileKey_domainName :: Lens' AddProfileKey Text
- data AddProfileKeyResponse = AddProfileKeyResponse' {}
- newAddProfileKeyResponse :: Int -> AddProfileKeyResponse
- addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text)
- addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text])
- addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int
Creating a Request
data AddProfileKey Source #
See: newAddProfileKey
smart constructor.
AddProfileKey' | |
|
Instances
Create a value of AddProfileKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddProfileKey
, addProfileKey_profileId
- The unique identifier of a customer profile.
AddProfileKey
, addProfileKey_keyName
- 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.
AddProfileKey
, addProfileKey_values
- A list of key values.
AddProfileKey
, addProfileKey_domainName
- The unique name of the domain.
Request Lenses
addProfileKey_profileId :: Lens' AddProfileKey Text Source #
The unique identifier of a customer profile.
addProfileKey_keyName :: Lens' AddProfileKey Text Source #
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.
addProfileKey_values :: Lens' AddProfileKey [Text] Source #
A list of key values.
addProfileKey_domainName :: Lens' AddProfileKey Text Source #
The unique name of the domain.
Destructuring the Response
data AddProfileKeyResponse Source #
See: newAddProfileKeyResponse
smart constructor.
Instances
newAddProfileKeyResponse Source #
Create a value of AddProfileKeyResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AddProfileKey
, addProfileKeyResponse_keyName
- A searchable identifier of a customer profile.
AddProfileKey
, addProfileKeyResponse_values
- A list of key values.
$sel:httpStatus:AddProfileKeyResponse'
, addProfileKeyResponse_httpStatus
- The response's http status code.
Response Lenses
addProfileKeyResponse_keyName :: Lens' AddProfileKeyResponse (Maybe Text) Source #
A searchable identifier of a customer profile.
addProfileKeyResponse_values :: Lens' AddProfileKeyResponse (Maybe [Text]) Source #
A list of key values.
addProfileKeyResponse_httpStatus :: Lens' AddProfileKeyResponse Int Source #
The response's http status code.