updateEmailConfigs
post
/ccstore/v1/shareSettings/{id}/updateEmailConfigs
Update Email Configs for a given Share Setting. This operation is used to update email configs the provided share setting. Each email must be unique to the share setting for which it is being created.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The ID of the requested Share Setting.
Root Schema : updateEmailConfigs_request
Type:
Show Source
object
-
emailConfigs:
array emailConfigs
Email configurations to be updated.
Example:
{
"emailConfigs":[
{
"editEnabled":true,
"id":"100001",
"email":"newman@example.com"
}
]
}
Nested Schema : items
Type:
Show Source
object
-
editEnabled(optional):
boolean
Whether the recipient has edit access for the resource being shared.
-
email(optional):
string
Email ID of the recipient.
-
id(optional):
string
ID of the email config.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateEmailConfigs_response
Type:
Show Source
object
-
emailConfigs(optional):
array emailConfigs
Updated Email configurations.
Example Response (application/json)
{
"emailConfigs":[
{
"id":"100001"
}
]
}
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|00001000|The user is not authenticated.|
|64505|Share setting does not exist or you do not have access to it.|
|64513|"emailConfig" is required Property. Either "emailConfig" is not provided or is empty.|
|23006|Invalid email address specified.|
|64514|You already have an Email Config for email.|
|64511|Email config does not exist or you do not have access to it.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code