1. REST API for Oracle B2C Service
  2. Tasks
  3. Contacts

Update a contact

patch

/services/rest/connect/v1.4/contacts/{id}

Request

Path Parameters
Body ()
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
Nested Schema : contacts-address
Type: object
The address information of the entity.
Show Source
Nested Schema : contacts-banner
Type: object
The display flags of a banner.
Show Source
Nested Schema : contacts-channelUsernames
Type: object
The user name of the channel.
Show Source
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
Nested Schema : contacts-cRMModules
Type: object
The flags which indicate the CRM modules applicable for an object.
Show Source
  • Indicates whether the marketing module is applicable. The default value is true only if marketing module is enabled.
  • Indicates whether the sales module is applicable. The default value is true only if sales module is enabled.
  • 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
Nested Schema : contacts-fileAttachments
Type: object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
Nested Schema : contacts-marketingSettings
Type: object
The marketing related information for the contact.
Show Source
Nested Schema : contacts-name
Type: object
The full name of the person, including the first name and the last name.
Show Source
Nested Schema : contacts-nameFurigana
Type: object
The full name of the person, including the first name and the last name.
Show Source
Nested Schema : contacts-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
Nested Schema : contacts-openIDAccounts
Type: object
The OpenID related information for the contact.
Show Source
Nested Schema : contacts-phones
Type: object
The details related to the phone number.
Show Source
  • Maximum Length: 40
    Pattern: ^[][+0-9a-zA-Z[:blank:].,()#-/:]*$
    The free-form phone number including non-numeric characters. For example, 1 (406) 522-4200.
  • 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.
  • 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
  • The date when the first opportunity associated with the contact was closed. This attribute is read-only.
  • 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
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
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
Nested Schema : namedIDs-contacts-banner-importanceFlag
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
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
Nested Schema : namedIDs-contacts-marketingSettings-contactLists
Type: object
The named ID that can be included in a list.
Show Source
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
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
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
Nested Schema : contacts-serviceSettings-answerNotifications
Type: object
The notification that is sent to a contact when an answer is updated.
Show Source
  • 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.
  • 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.
  • 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
    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.
  • 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.
  • 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
  • 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
    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.
  • 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
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
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
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
Back to Top

Response

Default Response

Back to Top

Examples

Use the PATCH operation with the following syntax to partially update a contact object:

https://your_site_interface/services/rest/connect/version/contacts/contact_id

Include the data to be updated in the request body. Only the fields present in the request JSON data are updated. All other fields remain the same.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contacts/2

Request body example

{
"address": {
    "city": "Boston",
    "postalCode": "02150",
    "stateOrProvince": {
        "lookupName": "MA"
        },
    "street": "123 Beacon Street"
    }
}

Response example

returns the status 200 OK. A subsequent GET request for the address data for that contact:

https://mysite.example.com/services/rest/connect/v1.4/contacts/2/address

returns the following:

{
"address": {
    "city": "Boston",
    "country": {
        "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/1"
            },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/countries/1"
            },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/countries"
            }
        ]
    },
    "postalCode": "02150",
    "stateOrProvince": {
        "id": 23,
        "lookupName": "MA"
        },
    "street": "123 Beacon Street"}
}

Note:

The address for contact 2 used to be in Bozeman, Montana.
Back to Top