Create a contact
post
/services/rest/connect/v1.4/contacts
Request
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status.
Root Schema : contacts
Type:
object
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status.
Show Source
-
address(optional):
object contacts-address
The address information of the entity.
-
banner(optional):
object contacts-banner
The display flags of a banner.
-
channelUsernames(optional):
object contacts-channelUsernames
The user name of the channel.
-
contactType(optional):
object namedIDs-contacts-contactType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdTime(optional):
string
The date and time when the contact was created. This attribute is read-only.
-
cRMModules(optional):
object contacts-cRMModules
The flags which indicate the CRM modules applicable for an object.
-
disabled(optional):
boolean
Indicates whether the contact is disabled. The default value is false.
-
emails(optional):
object contacts-emails
The email address and its associated information.
-
externalReference(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[1-9][0-9]*$
The external reference key of the contact. -
fileAttachments(optional):
object contacts-fileAttachments
The file attachment that includes additional fields used for attachments to various classes.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the contact. -
login(optional):
[
"string",
"null"
]
Maximum Length:
255
Pattern:^[^ <>"]*$
The user name used for authentication. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the contact. -
marketingSettings(optional):
object contacts-marketingSettings
The marketing related information for the contact.
-
name(optional):
object contacts-name
The full name of the person, including the first name and the last name.
-
nameFurigana(optional):
object contacts-nameFurigana
The full name of the person, including the first name and the last name.
-
newPassword(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[^ ]*$
The new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only. -
notes(optional):
object contacts-notes
The note text associated with the objects such as contacts and organizations.
-
openIDAccounts(optional):
object contacts-openIDAccounts
The OpenID related information for the contact.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
passwordEmailExpirationTime(optional):
[
"string",
"null"
]
The date and time by when the contact must change the password after a reset has occurred. This attribute is read-only.
-
passwordExpirationTime(optional):
[
"string",
"null"
]
The date and time by when the password is set to expire. This attribute is read-only.
-
phones(optional):
object contacts-phones
The details related to the phone number.
-
salesSettings(optional):
object contacts-salesSettings
The sales related information for the contact.
-
serviceSettings(optional):
object contacts-serviceSettings
The service related information for the contact.
-
source(optional):
object namedIDHierarchies-contacts-source
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
supersededBy(optional):
[
"object",
"null"
]
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
title(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The social or professional title of the contact. For example, Mrs., Dr., and so on. -
updatedTime(optional):
string
The date and time when the contact was last updated. This attribute is read-only.
Nested Schema : contacts-address
Type:
object
The address information of the entity.
Show Source
-
city(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The name of the city. -
country(optional):
[
"object",
"null"
]
The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource.
-
postalCode(optional):
[
"string",
"null"
]
Maximum Length:
10
Pattern:^[^ ]*$
The postal code or the ZIP code. -
stateOrProvince(optional):
object namedIDs-contacts-address-stateOrProvince
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
street(optional):
[
"string",
"null"
]
Maximum Length:
240
The street address.
Nested Schema : contacts-channelUsernames
Type:
object
The user name of the channel.
Show Source
-
channelType(optional):
object channelType
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts. It is the reference to a resource in 'channelTypes' collection. Only ID or lookupName can be provided to specify the resource.
-
username(optional):
[
"string",
"null"
]
Maximum Length:
255
Pattern:^[^ ]*$
The user name for this communication channel. -
userNumber(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[0-9A-Za-z_]+$
The user number ID for this communication channel. It is a string with a value between 0 and 9.
Nested Schema : namedIDs-contacts-contactType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contacts-cRMModules
Type:
object
The flags which indicate the CRM modules applicable for an object.
Show Source
-
marketing(optional):
boolean
Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
-
sales(optional):
boolean
Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
-
service(optional):
boolean
Indicates whether the service module is applicable. The default value is true only if service module is enabled.
Nested Schema : contacts-emails
Type:
object
The email address and its associated information.
Show Source
-
address(optional):
string
Maximum Length:
255
Pattern:^((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[; ]*)$
The string value of the email address. -
addressType(optional):
object namedIDs-contacts-emails-addressType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
certificate(optional):
[
"string",
"null"
]
Maximum Length:
1333
Pattern:^( | )*[-]+BEGIN CERTIFICATE[-]+[0-9a-zA-Z+/= ]*[-]+END CERTIFICATE[-]+( | )*$
The associated public email certificate used to encrypt outgoing emails. -
invalid(optional):
boolean
Indicates whether the email address is disabled.
Nested Schema : contacts-fileAttachments
Type:
object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
-
contentType(optional):
string
Maximum Length:
128
Pattern:^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. -
createdTime(optional):
string
The date and time when the file was associated with the object. This attribute is read-only.
-
data(optional):
string
The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
-
description(optional):
string
Maximum Length:
1333
The description for the contents of the file attachment. -
fileName(optional):
string
Maximum Length:
100
Pattern:^[^ \/:*?"<>|]*$
The name of the file when saving it to the disk. -
formData(optional):
string
The HTML form which is used to upload file attachments.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the file attachment. -
name(optional):
string
Maximum Length:
40
Pattern:^[^ ]*$
The short display name of the file attachment. -
size(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The size of the file in bytes. This attribute is read-only. -
updatedTime(optional):
[
"string",
"null"
]
The date and time when the file attachment was last updated. This attribute is read-only.
-
uRL(optional):
string
Maximum Length:
1333
The URL to access this file.
Nested Schema : contacts-marketingSettings
Type:
object
The marketing related information for the contact.
Show Source
-
contactLists(optional):
object namedIDs-contacts-marketingSettings-contactLists
The named ID that can be included in a list.
-
emailFormat(optional):
object namedIDs-contacts-marketingSettings-emailFormat
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
marketingOptIn(optional):
[
"boolean",
"null"
]
Indicates whether the contact has opted in for marketing mailing list. This attribute does not have a default value.
-
marketingOrganizationName(optional):
[
"string",
"null"
]
Maximum Length:
80
The marketing organization name. -
marketingOrganizationNameAlt(optional):
[
"string",
"null"
]
Maximum Length:
80
The alternate name of the marketing organization. -
surveyOptIn(optional):
[
"boolean",
"null"
]
Indicates whether the contact has opted in for providing feedback. This attribute does not have a default value.
Nested Schema : contacts-name
Type:
object
The full name of the person, including the first name and the last name.
Show Source
-
first(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The first name of the person. -
last(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The surname or last name of the person.
Nested Schema : contacts-nameFurigana
Type:
object
The full name of the person, including the first name and the last name.
Show Source
-
first(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The first name of the person. -
last(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The surname or last name of the person.
Nested Schema : contacts-notes
Type:
object
The note text associated with the objects such as contacts and organizations.
Show Source
-
channel(optional):
object namedIDs-contacts-notes-channel
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the note was created. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the note. -
text(optional):
string
Maximum Length:
349525
The text content in the note. -
updatedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the note was last updated. This attribute is read-only.
Nested Schema : contacts-openIDAccounts
Type:
object
The OpenID related information for the contact.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier for the list entry. -
uRL(optional):
string
Maximum Length:
255
The unique authentication URL for the OpenIDAccount item.
Nested Schema : contacts-phones
Type:
object
The details related to the phone number.
Show Source
-
number(optional):
string
Maximum Length:
40
Pattern:^[][+0-9a-zA-Z[:blank:].,()#-/:]*$
The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200. -
phoneType(optional):
object namedIDs-contacts-phones-phoneType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
rawNumber(optional):
string
Maximum Length:
40
The automatically populated numeric string derived by excluding the non-numeric characters from the value of the Number attribute. For example, if the Number attribute has a value of 1 (406) 522-4200, this field is populated as 14065224200. This attribute is read-only.
Nested Schema : contacts-salesSettings
Type:
object
The sales related information for the contact.
Show Source
-
acquiredDate(optional):
[
"string",
"null"
]
The date when the first opportunity associated with the contact was closed. This attribute is read-only.
-
salesAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : contacts-serviceSettings
Type:
object
The service related information for the contact.
Show Source
-
answerNotifications(optional):
object contacts-serviceSettings-answerNotifications
The notification that is sent to a contact when an answer is updated.
-
categoryNotifications(optional):
object contacts-serviceSettings-categoryNotifications
The notification sent to a contact when a category is updated.
-
productNotifications(optional):
object contacts-serviceSettings-productNotifications
The notification sent to a contact when a product is updated.
-
sLAInstances(optional):
object contacts-serviceSettings-sLAInstances
The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.
Nested Schema : namedIDHierarchies-contacts-source
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object -
parents(optional):
object namedIDHierarchies-contacts-source-parents
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Nested Schema : namedIDs-contacts-address-stateOrProvince
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : channelType
Type:
object
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts. It is the reference to a resource in 'channelTypes' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-contacts-emails-addressType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-marketingSettings-contactLists
Type:
object
The named ID that can be included in a list.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the object. This is the key for the list entry. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the object.
Nested Schema : namedIDs-contacts-marketingSettings-emailFormat
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-notes-channel
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-phones-phoneType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contacts-serviceSettings-answerNotifications
Type:
object
The notification that is sent to a contact when an answer is updated.
Show Source
-
answer(optional):
object answer
The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
[
"string",
"null"
]
The date and time when the notification period began. This attribute is read-only.
Nested Schema : contacts-serviceSettings-categoryNotifications
Type:
object
The notification sent to a contact when a category is updated.
Show Source
-
category(optional):
object category
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
string
The date and time when the notification period begins.
Nested Schema : contacts-serviceSettings-productNotifications
Type:
object
The notification sent to a contact when a product is updated.
Show Source
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
product(optional):
object product
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
string
The date and time when the notification period began.
Nested Schema : contacts-serviceSettings-sLAInstances
Type:
object
The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.
Show Source
-
activeDate(optional):
string
The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1.
-
expireDate(optional):
string
The date and time when the instance is scheduled to expire. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1. -
nameOfSLA(optional):
object namedIDs-contacts-serviceSettings-sLAInstances-nameOfSLA
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
remainingFromChat(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of chat incidents remaining. This attribute is read-only. -
remainingFromCSR(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of CSR incidents remaining. This attribute is read-only. -
remainingFromEmail(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of email incidents remaining. This attribute is read-only. -
remainingFromWeb(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of web self-service incidents remaining. This attribute is read-only. -
remainingTotal(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The total number of incidents remaining. This attribute is read-only. -
sLASet(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The SLA set from which the instance was created. This attribute is read-only. -
stateOfSLA(optional):
object namedIDs-contacts-serviceSettings-sLAInstances-stateOfSLA
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : answer
Type:
object
The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : category
Type:
object
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : product
Type:
object
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-contacts-serviceSettings-sLAInstances-nameOfSLA
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-serviceSettings-sLAInstances-stateOfSLA
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDHierarchies-contacts-source-parents
Type:
object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value. Read-only -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Response
Default Response
Root Schema : contacts
Type:
object
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status.
Show Source
-
address(optional):
object contacts-address
The address information of the entity.
-
banner(optional):
object contacts-banner
The display flags of a banner.
-
channelUsernames(optional):
object contacts-channelUsernames
The user name of the channel.
-
contactType(optional):
object namedIDs-contacts-contactType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdTime(optional):
string
The date and time when the contact was created. This attribute is read-only.
-
cRMModules(optional):
object contacts-cRMModules
The flags which indicate the CRM modules applicable for an object.
-
disabled(optional):
boolean
Indicates whether the contact is disabled. The default value is false.
-
emails(optional):
object contacts-emails
The email address and its associated information.
-
externalReference(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[1-9][0-9]*$
The external reference key of the contact. -
fileAttachments(optional):
object contacts-fileAttachments
The file attachment that includes additional fields used for attachments to various classes.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the contact. -
login(optional):
[
"string",
"null"
]
Maximum Length:
255
Pattern:^[^ <>"]*$
The user name used for authentication. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the contact. -
marketingSettings(optional):
object contacts-marketingSettings
The marketing related information for the contact.
-
name(optional):
object contacts-name
The full name of the person, including the first name and the last name.
-
nameFurigana(optional):
object contacts-nameFurigana
The full name of the person, including the first name and the last name.
-
newPassword(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[^ ]*$
The new password for authentication. It is stored with a one-way encryption in the system. This attribute is write-only. -
notes(optional):
object contacts-notes
The note text associated with the objects such as contacts and organizations.
-
openIDAccounts(optional):
object contacts-openIDAccounts
The OpenID related information for the contact.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
passwordEmailExpirationTime(optional):
[
"string",
"null"
]
The date and time by when the contact must change the password after a reset has occurred. This attribute is read-only.
-
passwordExpirationTime(optional):
[
"string",
"null"
]
The date and time by when the password is set to expire. This attribute is read-only.
-
phones(optional):
object contacts-phones
The details related to the phone number.
-
salesSettings(optional):
object contacts-salesSettings
The sales related information for the contact.
-
serviceSettings(optional):
object contacts-serviceSettings
The service related information for the contact.
-
source(optional):
object namedIDHierarchies-contacts-source
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
supersededBy(optional):
[
"object",
"null"
]
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
title(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The social or professional title of the contact. For example, Mrs., Dr., and so on. -
updatedTime(optional):
string
The date and time when the contact was last updated. This attribute is read-only.
Nested Schema : contacts-address
Type:
object
The address information of the entity.
Show Source
-
city(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The name of the city. -
country(optional):
[
"object",
"null"
]
The details about the countries and provinces which are used to maintain accurate address information for the organizations and contacts in Oracle B2C Service. It is the reference to a resource in 'countries' collection. Only ID or lookupName can be provided to specify the resource.
-
postalCode(optional):
[
"string",
"null"
]
Maximum Length:
10
Pattern:^[^ ]*$
The postal code or the ZIP code. -
stateOrProvince(optional):
object namedIDs-contacts-address-stateOrProvince
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
street(optional):
[
"string",
"null"
]
Maximum Length:
240
The street address.
Nested Schema : contacts-channelUsernames
Type:
object
The user name of the channel.
Show Source
-
channelType(optional):
object channelType
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts. It is the reference to a resource in 'channelTypes' collection. Only ID or lookupName can be provided to specify the resource.
-
username(optional):
[
"string",
"null"
]
Maximum Length:
255
Pattern:^[^ ]*$
The user name for this communication channel. -
userNumber(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[0-9A-Za-z_]+$
The user number ID for this communication channel. It is a string with a value between 0 and 9.
Nested Schema : namedIDs-contacts-contactType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contacts-cRMModules
Type:
object
The flags which indicate the CRM modules applicable for an object.
Show Source
-
marketing(optional):
boolean
Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
-
sales(optional):
boolean
Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
-
service(optional):
boolean
Indicates whether the service module is applicable. The default value is true only if service module is enabled.
Nested Schema : contacts-emails
Type:
object
The email address and its associated information.
Show Source
-
address(optional):
string
Maximum Length:
255
Pattern:^((([-_!#$%&'*+/=?^~`{|}\w]+(\.[.]?[-_!#$%&'*+/=?^~`{|}\w]+)*)|("[^"]+"))@[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*(\.[0-9A-Za-z]+([\-]+[0-9A-Za-z]+)*)+[; ]*)$
The string value of the email address. -
addressType(optional):
object namedIDs-contacts-emails-addressType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
certificate(optional):
[
"string",
"null"
]
Maximum Length:
1333
Pattern:^( | )*[-]+BEGIN CERTIFICATE[-]+[0-9a-zA-Z+/= ]*[-]+END CERTIFICATE[-]+( | )*$
The associated public email certificate used to encrypt outgoing emails. -
invalid(optional):
boolean
Indicates whether the email address is disabled.
Nested Schema : contacts-fileAttachments
Type:
object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
-
contentType(optional):
string
Maximum Length:
128
Pattern:^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. -
createdTime(optional):
string
The date and time when the file was associated with the object. This attribute is read-only.
-
data(optional):
string
The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
-
description(optional):
string
Maximum Length:
1333
The description for the contents of the file attachment. -
fileName(optional):
string
Maximum Length:
100
Pattern:^[^ \/:*?"<>|]*$
The name of the file when saving it to the disk. -
formData(optional):
string
The HTML form which is used to upload file attachments.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the file attachment. -
name(optional):
string
Maximum Length:
40
Pattern:^[^ ]*$
The short display name of the file attachment. -
size(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The size of the file in bytes. This attribute is read-only. -
updatedTime(optional):
[
"string",
"null"
]
The date and time when the file attachment was last updated. This attribute is read-only.
-
uRL(optional):
string
Maximum Length:
1333
The URL to access this file.
Nested Schema : contacts-marketingSettings
Type:
object
The marketing related information for the contact.
Show Source
-
contactLists(optional):
object namedIDs-contacts-marketingSettings-contactLists
The named ID that can be included in a list.
-
emailFormat(optional):
object namedIDs-contacts-marketingSettings-emailFormat
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
marketingOptIn(optional):
[
"boolean",
"null"
]
Indicates whether the contact has opted in for marketing mailing list. This attribute does not have a default value.
-
marketingOrganizationName(optional):
[
"string",
"null"
]
Maximum Length:
80
The marketing organization name. -
marketingOrganizationNameAlt(optional):
[
"string",
"null"
]
Maximum Length:
80
The alternate name of the marketing organization. -
surveyOptIn(optional):
[
"boolean",
"null"
]
Indicates whether the contact has opted in for providing feedback. This attribute does not have a default value.
Nested Schema : contacts-name
Type:
object
The full name of the person, including the first name and the last name.
Show Source
-
first(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The first name of the person. -
last(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The surname or last name of the person.
Nested Schema : contacts-nameFurigana
Type:
object
The full name of the person, including the first name and the last name.
Show Source
-
first(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The first name of the person. -
last(optional):
[
"string",
"null"
]
Maximum Length:
80
Pattern:^[^ ]*$
The surname or last name of the person.
Nested Schema : contacts-notes
Type:
object
The note text associated with the objects such as contacts and organizations.
Show Source
-
channel(optional):
object namedIDs-contacts-notes-channel
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the note was created. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the note. -
text(optional):
string
Maximum Length:
349525
The text content in the note. -
updatedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the note was last updated. This attribute is read-only.
Nested Schema : contacts-openIDAccounts
Type:
object
The OpenID related information for the contact.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier for the list entry. -
uRL(optional):
string
Maximum Length:
255
The unique authentication URL for the OpenIDAccount item.
Nested Schema : contacts-phones
Type:
object
The details related to the phone number.
Show Source
-
number(optional):
string
Maximum Length:
40
Pattern:^[][+0-9a-zA-Z[:blank:].,()#-/:]*$
The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200. -
phoneType(optional):
object namedIDs-contacts-phones-phoneType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
rawNumber(optional):
string
Maximum Length:
40
The automatically populated numeric string derived by excluding the non-numeric characters from the value of the Number attribute. For example, if the Number attribute has a value of 1 (406) 522-4200, this field is populated as 14065224200. This attribute is read-only.
Nested Schema : contacts-salesSettings
Type:
object
The sales related information for the contact.
Show Source
-
acquiredDate(optional):
[
"string",
"null"
]
The date when the first opportunity associated with the contact was closed. This attribute is read-only.
-
salesAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : contacts-serviceSettings
Type:
object
The service related information for the contact.
Show Source
-
answerNotifications(optional):
object contacts-serviceSettings-answerNotifications
The notification that is sent to a contact when an answer is updated.
-
categoryNotifications(optional):
object contacts-serviceSettings-categoryNotifications
The notification sent to a contact when a category is updated.
-
productNotifications(optional):
object contacts-serviceSettings-productNotifications
The notification sent to a contact when a product is updated.
-
sLAInstances(optional):
object contacts-serviceSettings-sLAInstances
The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.
Nested Schema : namedIDHierarchies-contacts-source
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object -
parents(optional):
object namedIDHierarchies-contacts-source-parents
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Nested Schema : namedIDs-contacts-address-stateOrProvince
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : channelType
Type:
object
The social channels tracked in contact records when storing social account user names and associating social monitor incidents to contacts. It is the reference to a resource in 'channelTypes' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-contacts-emails-addressType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-marketingSettings-contactLists
Type:
object
The named ID that can be included in a list.
Show Source
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the object. This is the key for the list entry. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the object.
Nested Schema : namedIDs-contacts-marketingSettings-emailFormat
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-notes-channel
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-phones-phoneType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : contacts-serviceSettings-answerNotifications
Type:
object
The notification that is sent to a contact when an answer is updated.
Show Source
-
answer(optional):
object answer
The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
[
"string",
"null"
]
The date and time when the notification period began. This attribute is read-only.
Nested Schema : contacts-serviceSettings-categoryNotifications
Type:
object
The notification sent to a contact when a category is updated.
Show Source
-
category(optional):
object category
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
string
The date and time when the notification period begins.
Nested Schema : contacts-serviceSettings-productNotifications
Type:
object
The notification sent to a contact when a product is updated.
Show Source
-
interface(optional):
[
"object",
"null"
]
The console, windows, and pages used by staff members and customers to access the application and interact with a single knowledge base. The interface name determines the URL for the web site, the name of the system executables, and the .cfg directory name. It is the reference to a resource in 'siteInterfaces' collection. Only ID or lookupName can be provided to specify the resource.
-
product(optional):
object product
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
-
startTime(optional):
string
The date and time when the notification period began.
Nested Schema : contacts-serviceSettings-sLAInstances
Type:
object
The instance of a Service Level Agreement (SLA), which is created when an SLA is associated with a contact or an organization.
Show Source
-
activeDate(optional):
string
The date and time when the instance became active. This attribute is read-only for versions 1 and 1.1.
-
expireDate(optional):
string
The date and time when the instance is scheduled to expire. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the SLA instance. This attribute is read-only and specify-to-get for versions 1 and 1.1. -
nameOfSLA(optional):
object namedIDs-contacts-serviceSettings-sLAInstances-nameOfSLA
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
remainingFromChat(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of chat incidents remaining. This attribute is read-only. -
remainingFromCSR(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of CSR incidents remaining. This attribute is read-only. -
remainingFromEmail(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of email incidents remaining. This attribute is read-only. -
remainingFromWeb(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The number of web self-service incidents remaining. This attribute is read-only. -
remainingTotal(optional):
integer
Minimum Value:
0
Maximum Value:2147483647
The total number of incidents remaining. This attribute is read-only. -
sLASet(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The SLA set from which the instance was created. This attribute is read-only. -
stateOfSLA(optional):
object namedIDs-contacts-serviceSettings-sLAInstances-stateOfSLA
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : answer
Type:
object
The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : category
Type:
object
The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : product
Type:
object
The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : namedIDs-contacts-serviceSettings-sLAInstances-nameOfSLA
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-contacts-serviceSettings-sLAInstances-stateOfSLA
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDHierarchies-contacts-source-parents
Type:
object
NamedID in which the ID is read-only. Used for hierarchies, where caller can specify the parents by name, but cannot specify the parent IDs.
Show Source
-
id(optional):
integer
Minimum Value:
1
ID value. Read-only -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Examples
Use POST with the following syntax to create a new contact object:
https://your_site_interface/services/rest/connect/version/contacts
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/contacts
Request body example
{
"name": {
"first": "Jonathan",
"last": "Randall"
}
}
Response body example
{
"id": 83,
"lookupName": "Jonathan Randall",
"createdTime": "2016-01-28T19:10:10.000Z",
"updatedTime": "2016-01-28T19:10:10.000Z",
"address": {
"city": null,
"country": null,
"postalCode": null,
"stateOrProvince": null,
"street": null
},
"banner": {
"importanceFlag": null,
"text": null,
"updatedByAccount": null,
"updatedTime": null
},
"channelUsernames": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/channelUsernames"
}
]
},
"contactType": null,
"cRMModules": {
"marketing": true,
"sales": true,
"service": true
},
"customFields": {
"c": {
"current_cust": null,
"age": null,
"wireless_provider": {
"id": 1,
"lookupName": "Technicomm"
}
}
},
"disabled": false,
"emails": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/emails"
}
]
},
"externalReference": null,
"fileAttachments": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/fileAttachments"
}
]
},
"login": null,
"marketingSettings": {
"contactLists": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/
marketingSettings/contactLists"
}
]
},
"emailFormat": null,
"marketingOptIn": null,
"marketingOrganizationName": null,
"marketingOrganizationNameAlt": null,
"surveyOptIn": null
},
"name": {
"first": "Jonathan",
"last": "Randall"
},
"nameFurigana": {
"first": null,
"last": null
},
"notes": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/notes"
}
]
},
"openIDAccounts": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/openIDAccounts"
}
]
},
"organization": null,
"passwordEmailExpirationTime": null,
"passwordExpirationTime": null,
"phones": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/phones"
}
]
},
"salesSettings": {
"acquiredDate": null,
"salesAccount": null
},
"serviceSettings": {
"answerNotifications": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/
serviceSettings/answerNotifications"
}
]
},
"categoryNotifications": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/
serviceSettings/categoryNotifications"
}
]
},
"productNotifications": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/
serviceSettings/productNotifications"
}
]
},
"sLAInstances": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83/
serviceSettings/sLAInstances"
}
]
}
},
"source": {
"id": 6016,
"lookupName": "Connect Web Services - REST",
"parents": [
{
"id": 32007,
"lookupName": "Public API"
}
]
},
"title": null,
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contacts",
"mediaType": "application/schema+json"
}
]
}