Jump to: navigation, search

Insert

Purpose

This method is intended for contact creation. No specific limitations related to "required" attributes are introduced here but they can be introduced at the client application level.

URL

  • POST /OMContacts/Insert/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
TenantId Integer Tenant Id true true
SubscriberId String The subscriber (that is, line of business) within the tenant to which the contact should belong. false true
Attributes KVList false true


Attributes KVList

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


KVList value

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


KVList value

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:

(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
Description String Description to be set for this contact attribute. For example, EmailAddress can be described as "(home)" or "(office)", etc false true null

Sample

TenantId 102
Attributes EmailAddress 0 AttrValue john.doe@genesys.com
1 AttrValue alice.doe@genesys.com
LastName 0 AttrValue Doe

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
ContactId String Id for the newly created contact true true


Error

FaultCode FaultString Description
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter.
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.