BAFAPI Send Email

BAFAPI Send Email 1.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://apigateway.bankalfalah.com/bankalfalah/sb

Paths

/v1

post /v1
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
OAuth
OAuth
(oauth2 application)

OAuth Authentication

Token URL
https://apigateway.bankalfalah.com/bankalfalah/sb/oauthproviderapi/oauth2/token
Scopes
GetToken
RequestBody
Required in body
object
RequestData
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Success

Response Body
500

Error

Error Response
Example Request
Example Response
POST https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1
Try this operation
https://apigateway.bankalfalah.com/bankalfalah/sb/bafapi-sendemail/v1
content-type
accept

Definitions 

{
    "type": "object",
    "properties": {
        "ChannelId": {
            "type": "string"
        },
        "ToEmailAddress": {
            "type": "string"
        },
        "Cc": {
            "type": "string"
        },
        "Bcc": {
            "type": "string"
        },
        "Subject": {
            "type": "string"
        },
        "Body": {
            "type": "string"
        },
        "Attachment": {
            "type": "object",
            "properties": {
                "ContentName": {
                    "type": "string"
                },
                "ContentType": {
                    "type": "string"
                },
                "ContentValue": {
                    "type": "string"
                }
            }
        }
    },
    "example": {
        "ChannelId": "1010",
        "ToEmailAddress": "abcd@bankalfalah.com",
        "Cc": "muhammad.ali",
        "Bcc": "",
        "Subject": "Leave Request",
        "Body": "Require Leaves",
        "Attachment": {
            "ContentName": "",
            "ContentType": "",
            "ContentValue": ""
        }
    },
    "required": [
        "Attachment",
        "Subject",
        "Bcc",
        "Body",
        "Cc",
        "ChannelId",
        "ToEmailAddress"
    ]
}
              
{
    "type": "object",
    "properties": {
        "ResponseCode": {
            "type": "string"
        },
        "ResponseDesc": {
            "type": "string"
        }
    },
    "example": {
        "ResponseCode": "99",
        "ResponseDesc": "Failed"
    }
}
              
{
    "type": "object",
    "properties": {
        "Response": {
            "type": "string"
        }
    },
    "example": {
        "Response": "true"
    }
}