Jump to: navigation, search

UpdateAttributes

Purpose

This method is intended for updating contact attributes. New attributes can be added or existing attributes can be updated or removed.

URL

  • PUT /OMContacts/UpdateAttributes/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactId String Any valid contact Id Id for the contact which attributes will be created, updated, or deleted true true
TenantId Integer true true
SubscriberId String The subscriber (that is, line of business) within the tenant to which the contact belongs false true
InsertAttributes KVList List with attributes which have to be inserted false true
UpdateAttributes KVList List with attributes which have to be updated false true
DeleteAttributes KVList List with attributes which have to be removed false true


InsertAttributes KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) KVList false true


KVList

Key ValueType Value Description Mandatory Unique Default
(Attribute Index) KVList (Attribute Index) == 0 means primary false true


KVList

Key ValueType Value Description Mandatory Unique Default
AttrValue StringBinary The value type of this parameter depends on the Contact Attribute type declared in Config Server(settings / type). If type is set to:

string (default): value must be a String date: value must be a String formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" binary: value must be a byte array

false true null
MimeType String Applicable for binary content,

Max. length: 256 characters

false true null
Description String Description to be set for this contact attribute. For example, EmailAddress can be described as "(home)" or "(office)", etc), false true null


UpdateAttributes KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) KVList false true


KVList

Key ValueType Value Description Mandatory Unique Default
(Attribute Index) KVList (Attribute Index) = 0 means primary) false true


KVList

Key ValueType Value Description Mandatory Unique Default
AttrId String Attribute Id true true
AttrValue StringBinary The value type of this parameter depends on the Contact Attribute type declared in Config Server (settings/type). If type is set to:

string(default): value must be a String Max. length: 256characters date: value must be a String formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" binary: value must be a byte array

false true null
MimeType String Applicable for binary content

Max. length: 256 characters

false true
Description String Description to be set for this contact attributes. For example, EmailAddress can be described as "(home)" or "(office)", etc false true


DeleteAttributes KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) KVList (AttributeName) is the system name of a Contact Attribute as declared in Configuration Serve r(Tenant specific configuration) false true


KVList

Key ValueType Value Description Mandatory Unique Default
AttrId String Attribute Id false false


Sample

ContactId KHS46XC46GK
TenantId 102
InsertAttributes EmailAddress 0 AttrValue alice.doe@genesys.com
LastName 0 AttrValue Doe
UpdateAttributes EmailAddress 1 AttrId JH8BVJH5J48KL59
AttrValue john.doe@genesys.com
DeleteAttributes EmailAddress AttrId SDF3S5435SDF5S3
AttrId GD6H5D4D6DF562X

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Attributes KVList List with all available (or a subset depending on AttributeList input parameter) attributes for the contact with requested ContactId false true


Attributes KVList

Key ValueType Value Description Mandatory Unique Default
(AttributeName) KVList (AttributeName) is the system name of a Contact Attribute as declared in Configuration Server(Tenant specific configuration) false true


KVList

Key ValueType Value Description Mandatory Unique Default
(Attribute Index) KVList (Attribute Index) == 0 means primary false true


KVList

Key ValueType Value Description Mandatory Unique Default
AttrId String Attribute Id true true
AttrValue StringBinary The value type of this parameter depends on the Contact Attribute type declared in Config Server (settings/type). If type is set to:

string(default): value is a String date: value is a String formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" binary: value is a byte array

false true null
MimeType String Applicable for binary contentReturned only if not null. false true
Description String This is the description that can be attached to the contact attribute. Returned only if not null. For example, EmailAddress can be described as "(home)" or "(office)", etc false true


Error

FaultCode FaultString Description
510 {0} not found in database Contact with Id=(ContactId) is not found in database
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
732 Invalid Tenant {0} Provided tenant is not configured in UCS
921 SubscriberId '{0}' is invalid or not active. The provided SubscriberId is not valid.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.