Create a vanity domain.

POST /organization/vanity-domain

Body Required

Create a new vanity domain

  • domain_name string Required

    The vanity domain to create.

  • service_type string Required

    The Canopy service to create the domain for.

    Values are os, borrower-portal, or guest-pay.

Responses

  • • 200 object

    Successful creation of a vanity domain

    • domain_name string Required

      The vanity domain to create.

    • service_type string Required

      The Canopy service to create the domain for.

      Values are os, borrower-portal, or guest-pay.

    • status string Required

      The status of the vanity domain.

      Values are pending, complete, failed, or deleting.

    • status_details string

      The status details.

    • records array[object] Required

      The DNS records to create.

      • name string Required

        The record name.

      • value string Required

        The record value.

      • type string Required

        DNS record type.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

POST /organization/vanity-domain 
curl \
 -X POST https://<your_environment_name>-uat-api.canopyservicing.com/organization/vanity-domain \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"domain_name":"portal.wizebank.com","service_type":"borrower-portal"}'
Request example 
{
  "domain_name": "portal.wizebank.com",
  "service_type": "borrower-portal"
}
Response example (200) 
{
  "domain_name": "portal.wizebank.com",
  "service_type": "borrower-portal",
  "status": "pending",
  "status_details": "Waiting for validation.",
  "records": [
    {
      "name": "portal.wizebank.com",
      "value": "portal-wizebank-com-vanity.wizebank.tenant.canopyservicing.com.",
      "type": "CNAME"
    }
  ]
}