Skip to content

Update Profile

customerprofiles_update_profile R Documentation

Updates the properties of a profile

Description

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

Usage

customerprofiles_update_profile(DomainName, ProfileId,
  AdditionalInformation, AccountNumber, PartyType, BusinessName,
  FirstName, MiddleName, LastName, BirthDate, Gender, PhoneNumber,
  MobilePhoneNumber, HomePhoneNumber, BusinessPhoneNumber, EmailAddress,
  PersonalEmailAddress, BusinessEmailAddress, Address, ShippingAddress,
  MailingAddress, BillingAddress, Attributes, PartyTypeString,
  GenderString)

Arguments

DomainName

[required] The unique name of the domain.

ProfileId

[required] The unique identifier of a customer profile.

AdditionalInformation

Any additional information relevant to the customer’s profile.

AccountNumber

An account number that you have given to the customer.

PartyType

The type of profile used to describe the customer.

BusinessName

The name of the customer’s business.

FirstName

The customer’s first name.

MiddleName

The customer’s middle name.

LastName

The customer’s last name.

BirthDate

The customer’s birth date.

Gender

The gender with which the customer identifies.

PhoneNumber

The customer’s phone number, which has not been specified as a mobile, home, or business number.

MobilePhoneNumber

The customer’s mobile phone number.

HomePhoneNumber

The customer’s home phone number.

BusinessPhoneNumber

The customer’s business phone number.

EmailAddress

The customer’s email address, which has not been specified as a personal or business address.

PersonalEmailAddress

The customer’s personal email address.

BusinessEmailAddress

The customer’s business email address.

Address

A generic address associated with the customer that is not mailing, shipping, or billing.

ShippingAddress

The customer’s shipping address.

MailingAddress

The customer’s mailing address.

BillingAddress

The customer’s billing address.

Attributes

A key value pair of attributes of a customer profile.

PartyTypeString

An alternative to PartyType which accepts any string as input.

GenderString

An alternative to Gender which accepts any string as input.

Value

A list with the following syntax: 

list(
  ProfileId = "string"
)

Request syntax

svc$update_profile(
  DomainName = "string",
  ProfileId = "string",
  AdditionalInformation = "string",
  AccountNumber = "string",
  PartyType = "INDIVIDUAL"|"BUSINESS"|"OTHER",
  BusinessName = "string",
  FirstName = "string",
  MiddleName = "string",
  LastName = "string",
  BirthDate = "string",
  Gender = "MALE"|"FEMALE"|"UNSPECIFIED",
  PhoneNumber = "string",
  MobilePhoneNumber = "string",
  HomePhoneNumber = "string",
  BusinessPhoneNumber = "string",
  EmailAddress = "string",
  PersonalEmailAddress = "string",
  BusinessEmailAddress = "string",
  Address = list(
    Address1 = "string",
    Address2 = "string",
    Address3 = "string",
    Address4 = "string",
    City = "string",
    County = "string",
    State = "string",
    Province = "string",
    Country = "string",
    PostalCode = "string"
  ),
  ShippingAddress = list(
    Address1 = "string",
    Address2 = "string",
    Address3 = "string",
    Address4 = "string",
    City = "string",
    County = "string",
    State = "string",
    Province = "string",
    Country = "string",
    PostalCode = "string"
  ),
  MailingAddress = list(
    Address1 = "string",
    Address2 = "string",
    Address3 = "string",
    Address4 = "string",
    City = "string",
    County = "string",
    State = "string",
    Province = "string",
    Country = "string",
    PostalCode = "string"
  ),
  BillingAddress = list(
    Address1 = "string",
    Address2 = "string",
    Address3 = "string",
    Address4 = "string",
    City = "string",
    County = "string",
    State = "string",
    Province = "string",
    Country = "string",
    PostalCode = "string"
  ),
  Attributes = list(
    "string"
  ),
  PartyTypeString = "string",
  GenderString = "string"
)