Jump to

• Request
• Response

Send email

post

/api/v1/applications/sendCorrespondence

Send a responsive email related to an application. Only 'from scratch' email is supported (no templates)

Request

Supported Media Types

• application/json

Body ()

Message details to send email.

Root Schema : SendCorrespondence

The application send correspondence item.

Match All

Show Source

• object Singular Resource
  Title: Singular Resource

  Oracle base singular resource schema definition.
• object SendCorrespondence-allOf[1]

{
    "description":"The application send correspondence item.",
    "allOf":[
        {
            "$ref":"#/definitions/SingularResource"
        },
        {
            "properties":{
                "attributes":{
                    "type":"object",
                    "properties":{
                        "correspondenceDetails":{
                            "type":"array",
                            "items":{
                                "$ref":"#/definitions/CorrespondenceDetail"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : Singular Resource

Type: object

Title: Singular Resource

Oracle base singular resource schema definition.

Show Source

• links(optional): array links

{
    "title":"Singular Resource",
    "description":"Oracle base singular resource schema definition.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InstanceLink"
            }
        }
    }
}

Nested Schema : SendCorrespondence-allOf[1]

Type: object

Show Source

• attributes(optional): object attributes

{
    "properties":{
        "attributes":{
            "type":"object",
            "properties":{
                "correspondenceDetails":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/CorrespondenceDetail"
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object InstanceLink
  Metadata describing link description objects that may appear in the json instance representation.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/InstanceLink"
    }
}

Nested Schema : InstanceLink

Type: object

Metadata describing link description objects that may appear in the json instance representation.

Show Source

• href: string
  URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the template property must be set to true.
• mediaType(optional): string
  Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  HTTP method for requesting the target of the link.
• profile(optional): string
  Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel: string
  Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.
• templated(optional): boolean
  Boolean flag indicating that the \href\ property is a URI or URI Template. If the property is a URI template, set this value to true. The default value is False.

{
    "type":"object",
    "description":"Metadata describing link description objects that may appear in the json instance representation.",
    "properties":{
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the template property must be set to true.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "templated":{
            "description":"Boolean flag indicating that the \\href\\ property is a URI or URI Template. If the property is a URI template, set this value to true. The default value is False.",
            "type":"boolean"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ]
}

Nested Schema : attributes

Type: object

Show Source

• correspondenceDetails(optional): array correspondenceDetails

{
    "type":"object",
    "properties":{
        "correspondenceDetails":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CorrespondenceDetail"
            }
        }
    }
}

Nested Schema : correspondenceDetails

Type: array

Show Source

• [0]: object CorrespondenceDetail
  Correspondence Detail object. This holds email details used in sendCorrespondence.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CorrespondenceDetail"
    }
}

Nested Schema : CorrespondenceDetail

Type: object

Correspondence Detail object. This holds email details used in sendCorrespondence.

Show Source

• applicationId(optional): integer
  application id
• bcc(optional): string
  BCC address.
• body(optional): string
  Body of email. It can have html content.
• cc(optional): string
  CC address.
• from(optional): string
  From address. It can be either the preset value or valid email address. The value can be different from the preset email id, only when 'fromAddressEditable' setting is true.
• replyTo(optional): string
  Reply to address.
• subject(optional): string
  Subject for email.
• to(optional): string
  To address.

{
    "type":"object",
    "description":"Correspondence Detail object. This holds email details used in sendCorrespondence.",
    "properties":{
        "applicationId":{
            "description":"application id",
            "type":"integer"
        },
        "from":{
            "description":"From address. It can be either the preset value or valid email address. The value can be different from the preset email id, only when 'fromAddressEditable' setting is true.",
            "type":"string"
        },
        "to":{
            "description":"To address.",
            "type":"string"
        },
        "replyTo":{
            "description":"Reply to address.",
            "type":"string"
        },
        "bcc":{
            "description":"BCC address.",
            "type":"string"
        },
        "cc":{
            "description":"CC address.",
            "type":"string"
        },
        "subject":{
            "description":"Subject for email.",
            "type":"string"
        },
        "body":{
            "description":"Body of email. It can have html content.",
            "type":"string"
        }
    }
}

Back to Top

Response

201 Response

Successfully sent correspondence

400 Response

The error code represents an invalid request. For example: The 'from' email address is invalid.

Body ()

Root Schema : Represents an error response.

Type: object

Title: Represents an error response.

Represents an error response.

Show Source

• additionalProperties(optional): object additionalProperties
  Any additional properties apart from code, message or description.
• errors(optional): array errors

{
    "title":"Represents an error response.",
    "description":"Represents an error response.",
    "type":"object",
    "properties":{
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "additionalProperties":{
            "description":"Any additional properties apart from code, message or description.",
            "type":"object"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Any additional properties apart from code, message or description.

Nested Schema : errors

Type: array

Show Source

• [0]: object Represents a generic error.
  Title: Represents a generic error.

  Represents a generic error.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Nested Schema : Represents a generic error.

Type: object

Title: Represents a generic error.

Represents a generic error.

Show Source

• code(optional): integer
  Represents the error code.
• description(optional): string
  The error description text.
• message(optional): string
  The actual error message.

{
    "title":"Represents a generic error.",
    "description":"Represents a generic error.",
    "type":"object",
    "properties":{
        "code":{
            "type":"integer",
            "description":"Represents the error code."
        },
        "message":{
            "type":"string",
            "description":"The actual error message."
        },
        "description":{
            "type":"string",
            "description":"The error description text."
        }
    }
}

Default Response

Unexpected error.

Back to Top