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

Update an organization

patch

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

Request

Path Parameters
Body ()
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.
Root Schema : organizations
Type: object
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base.
Show Source
Nested Schema : organizations-addresses
Type: object
The physical address of the organization.
Show Source
Nested Schema : organizations-banner
Type: object
The display flags of a banner.
Show Source
Nested Schema : organizations-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 : organizations-fileAttachments
Type: object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
Nested Schema : namedIDs-organizations-industry
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 : organizations-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
Nested Schema : organizationHierarchy
Type: array
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 resources.
Show Source
Nested Schema : organizations-salesSettings
Type: object
The sales related information for the organization.
Show Source
Nested Schema : organizations-serviceSettings
Type: object
The service related information for the organization.
Show Source
Nested Schema : namedIDHierarchies-organizations-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-organizations-addresses-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-organizations-addresses-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-organizations-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 : namedIDs-organizations-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 : items
Type: object
Nested Schema : organizations-salesSettings-totalRevenue
Type: object
The monetary value that consists of currency, exchange rate, and value.
Show Source
Nested Schema : namedIDs-organizations-salesSettings-totalRevenue-currency
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-organizations-salesSettings-totalRevenue-exchangeRate
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 : organizations-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 : namedIDs-organizations-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-organizations-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-organizations-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 an organization object:

https://your_site_interface/services/rest/connect/version/organizations/organization_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/organizations/15

Request body example

{
"name": "Oracle Corporation"
}

Response example

returns the status 200 OK. A subsequent GET request for that organization:

https://mysite.example.com/services/rest/connect/v1.4/organizations/15

returns the following:

{
  "id": 15,
  "lookupName": "Oracle Corporation",
  "createdTime": "2010-12-01T20:31:53.000Z",
  "updatedTime": "2016-02-01T15:20:43.000Z",
  "addresses": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/organizations/15/addresses"
      }
    ]
  },

...

  "name": "Oracle Corporation",

...

}

Note:

The organization name used to be Verden.
Back to Top