Update an organization
patch
/services/rest/connect/v1.4/organizations/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the organization.
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
-
addresses(optional):
object organizations-addresses
The physical address of the organization.
-
banner(optional):
object organizations-banner
The display flags of a banner.
-
createdTime(optional):
string
The date and time when the organization was created. This attribute is read-only.
-
cRMModules(optional):
object organizations-cRMModules
The flags which indicate the CRM modules applicable for an object.
-
externalReference(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[1-9][0-9]*$
The external reference key of the organization. -
fileAttachments(optional):
object organizations-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 organization. -
industry(optional):
object namedIDs-organizations-industry
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.
-
login(optional):
[
"string",
"null"
]
Maximum Length:
40
Pattern:^[^ ]*$
The user name used for authentication. -
lookupName(optional):
string
Maximum Length:
255
The name used to look up the organization. -
name(optional):
string
Maximum Length:
80
The business name of the organization. -
nameFurigana(optional):
[
"string",
"null"
]
Maximum Length:
80
The Furigana reading aid for the Name field. This field is used in the workspaces of the Agent Console and is only available if the site has at least one Japanese interface. -
newPassword(optional):
[
"string",
"null"
]
Maximum Length:
20
Pattern:^[^ ]*$
The write-only field used to set the authentication password. It is stored in a non-plaintext form in the system. -
notes(optional):
object organizations-notes
The note text associated with the objects such as contacts and organizations.
-
numberOfEmployees(optional):
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:2147483647
The number of employees in the organization. -
organizationHierarchy(optional):
array organizationHierarchy
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.
-
parent(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.
-
salesSettings(optional):
object organizations-salesSettings
The sales related information for the organization.
-
serviceSettings(optional):
object organizations-serviceSettings
The service related information for the organization.
-
source(optional):
object namedIDHierarchies-organizations-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 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.
-
updatedTime(optional):
string
The date and time when the organization was last updated. This attribute is read-only.
Nested Schema : organizations-addresses
Type:
object
The physical address of the organization.
Show Source
-
addressType(optional):
object namedIDs-organizations-addresses-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.
-
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 ZIP code. -
stateOrProvince(optional):
object namedIDs-organizations-addresses-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 : organizations-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 : organizations-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 : 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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : organizations-notes
Type:
object
The note text associated with the objects such as contacts and organizations.
Show Source
-
channel(optional):
object namedIDs-organizations-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 : 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
-
acquiredDate(optional):
[
"string",
"null"
]
The date when the first opportunity associated with the organization 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.
-
totalRevenue(optional):
object organizations-salesSettings-totalRevenue
The monetary value that consists of currency, exchange rate, and value.
Nested Schema : organizations-serviceSettings
Type:
object
The service related information for the organization.
Show Source
-
sLAInstances(optional):
object organizations-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-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
-
id(optional):
integer
Minimum Value:
1
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object -
parents(optional):
object namedIDHierarchies-organizations-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-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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
currency(optional):
object namedIDs-organizations-salesSettings-totalRevenue-currency
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.
-
exchangeRate(optional):
object namedIDs-organizations-salesSettings-totalRevenue-exchangeRate
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.
-
value(optional):
number
The value of the currency.
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
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-organizations-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-organizations-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 : 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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
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
-
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
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.