transform

POSTCFO,ALL/SendNotificationToUser

Description

Sends a notification via email, SMS, or both to a TransForm user.

Headers 

Name
Description
apikey

REQUIRED - A TransForm API key with the appropriate scopes to access the endpoint. The API Key must have either the CFO or ALL scopes.

Parameters 

Name
Description
body

REQUIRED - JSON Object with the following properties defined:

email

REQUIRED, string; the email address of the notification recipient.

message

Optional, string; the message to send via email.

from_email

Optional, string; the email address for the notification sender.

subject

Optional, string, The email subject.

sms_message

Optional, string; the SMS message to send.

notificationType

Optional, string; the type of notification to send. If blank, the user's notification preferences are used. The notificationType can be "email", "sms", or both ("email,sms").

Example:

{
    "email":"[email protected]",
    "message":"Your form has been processed and approved.",
    "from_email":"[email protected]",
    "subject":"Approved!",
    "notificationType":"email"
}

Example Request 

curl --location --request POST 'https://alphademo1-transformbeta.cloud.alphasoftware.com/transformAPIVersion1.a5svc/SendNotificationToUser' \
--header 'apikey: YOUR_API_KEY' \
--header 'Content-Type: text/plain' \
--data-raw '{
    "email":" [email protected]",
    "message":"Your form has been processed and approved.",
    "from_email":"[email protected]",
    "subject":"Approved!",
    "notificationType":"email"
}'

Example Response 

{
    "error": false,
    "errorText": "",
    "result": {
        "email": {
            "error": false,
            "errorText": ""
        },
        "sms": {
            "error": false,
            "errorText": "SMS notification was not requested"
        }
    }
}