Specifying a brand/client name and logo | API

If you deal with multiple clients/brands, you may want to specify a logo and company name when you create the Process.  This logo and company name will be reflected in the email that is sent to the end user, and also within the mobile app / web app that they see.

NOTE: If you are a reseller you should consider setting up 'child portals' and applying full branding to each as relevant.

To use a specific client name/logo for your end user interaction, you need to add the following parameters into the ProcessEntities section of the POST /Process:

"clientAliasName": "string",

"clientAliasLogoBase64": "string"

For example:

{

    "title": "Example title",

    "journeyId": "guid",

    "webhookUrl": "string",

    "webhookStepUrl": "string",

    "userGroupId": "guid",

    "processEntities": [

        {

            "firstName": "John",

            "surname": "Smith",

            "emailAddress": "user@example.com",

            "phoneNumber": "07496701000",

            "reference": "Your customer reference",

            "actorId": 123,

            "contactViaEmail": true,

            "contactViaSms": true,

            "inPerson": false,

            "clientAliasName": "string",

            "clientAliasLogoBase64": "string" 

        }

    ]

}