Outreach

Introduction

Unit’s outreach experiences offer a high degree of customization to create branded web pages using Unit’s infrastructure. Outreach is utilized for fraud outreach, tax outreach, and more. To set up this configuration, you only need to perform a few simple steps. We strongly encourage you to follow the requisite steps and set this up yourself to ensure a seamless and branded experience for your customers.

1. Configure Email Domain and Address (Mandatory)
   Specify your email domain and address for sending outreach communications.
2. Configure Web Domain for Landing Pages (Mandatory) Specify your web domain to be used in outreach landing pages.
3. Create a Theme (Optional)
   Customize the theme for your branded communication and Card Fraud Outreach landing pages.

Detailed Configuration Instructions

1. Configure Your Email Domain

To enable Unit to send emails on your behalf, you must configure your email domain. This step consists of three sub-steps:

Step 1: Create Outreach Settings

Verb	POST
URL	https://api.s.unit.sh/outreach-settings
Data Type	emailOutreachSettings
Timeout (Seconds)	5

Attributes

Name	Type	Description
name Required	string	The setting name.
domain Required	string	Your domain.
sender.email Required	string	The sender email that will appear in the email.
sender.name Required	string	The sender name that will appear in the email.

Example Request:

curl -X POST 'https://api.s.unit.sh/outreach-settings'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "emailOutreachSettings",
    "attributes": {
      "name": "Outreach settings",
      "domain": "your-domain.com",
      "sender": {
        "email": "outlay.outreach@your-domain.com",
        "name": "Outlay Outreach"
      }
    }
  }
}'

Response

Response is a JSON:API document.

201 Created

Name	Type	Description
data	EmailOutreachSettings	The created EmailOutreachSettings resource.

Example response:

{
  "data": {
    "id": "10000",
    "type": "emailOutreachSettings",
    "attributes": {
      "createdAt": "2024-01-14T14:05:04.718Z",
      "domain": "your-domain.com",
      "name": "Outreach settings",
      "sender": "Outlay",
      "isVerified": false,
      "dnsRecords": [
        {
          "recordType": "CNAME",
          "key": "unt._domainkey.your-domain.com",
          "value": "unt.domainkey.u12341234.wl123.sendgrid.net",
          "isValid": false
        },
        {
          "recordType": "CNAME",
          "key": "unit2._domainkey.your-domain.com",
          "value": "unt2.domainkey.u12341234.wl123.sendgrid.net",
          "isValid": false
        },
        {
          "recordType": "CNAME",
          "key": "unit.your-domain.com",
          "value": "u12341234.wl123.sendgrid.net",
          "isValid": false
        },
        {
          "recordType": "TXT",
          "key": "_dmarc.your-domain.com",
          "value": "v=DMARC1; p=none;",
          "isValid": false
        }
      ]
    }
  }
}

Step 2: Add DNS Records to Your Domain

Add the DNS records returned in the response to your domain registrar. Ensure they are added within 72 hours for successful verification.

Record Name	Type	Record Value
unt._domainkey.your-domain.com	CNAME	unt.domainkey.u12341234.wl123.sendgrid.net
unt2._domainkey.your-domain.com	CNAME	unt2.domainkey.u12341234.wl123.sendgrid.net
unit.your-domain.com	CNAME	u12341234.wl123.sendgrid.net
_dmarc.your-domain.com	TXT	v=DMARC1; p=none;

Step 3: Verify Domain

Once DNS records are added, send a verification request:

Verb	POST
URL	https://api.s.unit.sh/outreach-settings/:settingsId/verify
Data Type	emailOutreachSettings
Timeout (Seconds)	5

• Once the DNS records are added, you can send a verification request to Unit. If the status has changed from isVerified: "false" to isVerified: "true", you have completed the subdomain configuration. If the status has not changed, the verification has not been completed. Note that the verification process may take a couple of minutes and in rare cases even hours, so wait a couple of minutes before retrying the verification.

Example Request:

curl -X POST 'https://api.s.unit.sh/outreach-settings/10000/verify'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'

Response

Response is a JSON:API document.

201 Created

Name	Type	Description
data	EmailOutreachSettings	The created EmailOutreachSettings resource.

Example response:

{
  "data": {
    "id": "10000",
    "type": "emailOutreachSettings",
    "attributes": {
      "createdAt": "2024-01-14T14:05:04.718Z",
      "name": "Outreach settings",
      "domain": "your-domain.com",
      "sender": "Outlay",
      "isVerified": true,
      "dnsRecords": [
        {
          "recordType": "CNAME",
          "key": "unt._domainkey.your-domain.com",
          "value": "unt.domainkey.u12341234.wl123.sendgrid.net",
          "isValid": true
        },
        {
          "recordType": "CNAME",
          "key": "unt2._domainkey.your-domain.com",
          "value": "unt.domainkey.u12341234.wl123.sendgrid.net",
          "isValid": true
        },
        {
          "recordType": "CNAME",
          "key": "unit.your-domain.com",
          "value": "u12341234.wl123.sendgrid.net",
          "isValid": true
        },
        {
          "recordType": "TXT",
          "key": "_dmarc.your-domain.com",
          "value": "v=DMARC1; p=none;",
          "isValid": true
        }
      ]
    }
  }
}

2. Configure Your Web Domain

Configure your web domain via the Unit Dashboard.

To the end-customer, it will look like the form is hosted on your sub-domain, while in practice it would be hosted by Unit. If you have already set this up in the past, you can skip this step.

To customize the URL:

1. On the Unit Dashboard, go to Org Settings / General and configure the subdomain.
2. Click “setup” and provide the URL you would like to use (e.g. apply.yourdomain.com). A new box called "DNS Settings" will show up on the form. The box includes 2 CNAME records that you will have to configure on your DNS provider within 72 hours in order to verify the domain. Examples:

Record Name	Type	Record Value
_x1.unit.yourdomain.com	CNAME	_x2.acm-validations.aws.
unit.yourdomain.com	CNAME	application-form.sh

• The first record is used to issue a certificate and to prove the domain ownership. x1, x2 are auto-generated random strings.

• The second record will redirect your new subdomain to Unit's form

After configuring the DNS records, return to the DNS Settings box and click Verify.

If the status has changed from "Unverified" to "Verified", you have completed the subdomain configuration.

If the status has not changed, the verification has not been completed. Note that the verification process may take a couple of minutes and in rare cases even hours, so wait a couple of minutes before retrying the verification.

3. Create a Theme

Create a theme for your outreach. Refer to Theme Documentation for more information. If you have already configured a theme for other products, you can re-use it. Find your existing themes using the list theme API. Then select your default theme in your Dashboard Org Settings.

Verb	POST
URL	https://api.s.unit.sh/white-label/theme
Data Type	whiteLabelTheme
Timeout (Seconds)	5

Attributes

Name	Type	Description
name Required	string	Theme Name.
logoUrl Required	string	URL to a logo image. Must be PNG.
colors Required	object	Color palette.

Example Request:

curl -X POST 'https://api.s.unit.sh/white-label/theme'
-H 'Content-Type: application/vnd.api+json'
-H 'Authorization: Bearer ${TOKEN}'
--data-raw '{
  "data": {
    "type": "whiteLabelTheme",
    "attributes": {
      "name": "Theme for outreach",
      "global": {
        "logoUrl": "https://www.example.com/logo.png",
        "colors": {
          "primary": "#0000F0",
          "secondary": "#000000",
          "success": "#000000",
          "error": "#0000A0"
        }
      }
    }
  }
}'