Jump to

• Request
• Response

saveOutboundEmailAppConfig

post

/crmRestApi/resources/11.13.18.05/inboundMessages/action/saveOutboundEmailAppConfig

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• activationDate: string
  Specifies the start date from which emails are read from an external email address.
• allowDeleteFlag: string
  Specifies a flag value (Y/N) to allow delete messages after processing.
• clientId: string
  Specifies the client ID used to configure an external email application.
• clientSecret: string
  Specifies the client secret used to configure an external email application.
• inboundEmailAddress: string
  Specifies the email address used to configure an external email application.
• tenantId: string
  Specifies the tenant ID used to configure an external email application.

{
    "type":"object",
    "properties":{
        "inboundEmailAddress":{
            "type":"string",
            "description":"Specifies the email address used to configure an external email application.",
            "nullable":true
        },
        "clientId":{
            "type":"string",
            "description":"Specifies the client ID used to configure an external email application.",
            "nullable":true
        },
        "tenantId":{
            "type":"string",
            "description":"Specifies the tenant ID used to configure an external email application.",
            "nullable":true
        },
        "allowDeleteFlag":{
            "type":"string",
            "description":"Specifies a flag value (Y/N) to allow delete messages after processing.",
            "nullable":true
        },
        "clientSecret":{
            "type":"string",
            "description":"Specifies the client secret used to configure an external email application.",
            "nullable":true
        },
        "activationDate":{
            "type":"string",
            "description":"Specifies the start date from which emails are read from an external email address.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Returns a nested map containing errorCode and response values such as tenantId, clientId, clientSecret, inboundEmailAddress, activationDate, allowDeleteFlag.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Returns a nested map containing errorCode and response values such as tenantId, clientId, clientSecret, inboundEmailAddress, activationDate, allowDeleteFlag."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Returns a nested map containing errorCode and response values such as tenantId, clientId, clientSecret, inboundEmailAddress, activationDate, allowDeleteFlag."
}

Returns a nested map containing errorCode and response values such as tenantId, clientId, clientSecret, inboundEmailAddress, activationDate, allowDeleteFlag.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top