Jump to

• Request
• Response

deleteEmailConfigs

post

/ccstore/v1/shareSettings/{id}/deleteEmailConfigs

Delete Email Configs for a given Share Setting. This operation is used to delete 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.

Body ()

Root Schema : deleteEmailConfigs_request

Type: object

Show Source

• emailConfigs: array emailConfigs
  Email configurations to be deleted.

{
    "properties":{
        "emailConfigs":{
            "description":"Email configurations to be deleted.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the email config.",
                        "type":"string"
                    }
                }
            }
        }
    },
    "required":[
        "emailConfigs"
    ],
    "example":{
        "emailConfigs":[
            {
                "id":"100001"
            }
        ]
    }
}

Example:

{
    "emailConfigs":[
        {
            "id":"100001"
        }
    ]
}

Nested Schema : emailConfigs

Type: array

Email configurations to be deleted.

Show Source

• Array of: object items

{
    "description":"Email configurations to be deleted.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of the email config.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  ID of the email config.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the email config.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : deleteEmailConfigs_response

Type: object

Show Source

• emailConfigs(optional): array emailConfigs
  Deleted Email configurations.

{
    "properties":{
        "emailConfigs":{
            "description":"Deleted Email configurations.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"ID of the email config.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : emailConfigs

Type: array

Deleted Email configurations.

Show Source

• Array of: object items

{
    "description":"Deleted Email configurations.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"ID of the email config.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  ID of the email config.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the email config.",
            "type":"string"
        }
    }
}

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.| |64511|Email config does not exist or you do not have access to it.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top