Yay.com loading

Loading

Call us on (917) 9001 YAY

Login to Yay.com

Did you know we also sell domains?

Add domain registration to your VoIP service and manage your business in one location, anytime!

  • $26.19 / year

    .co

  • $9.79 / year

    .com

  • $11.99 / year

    .net

  • $8.19 / year

    .shop

  • $8.59 / year

    .us

  • $1.19 / year

    .xyz

View all domain pricing

Email and Web Forwarding

API Access

Build custom apps using our JSON API

1st month FREE
Become a Reseller

Email Forwarding

Email forwarding allows a domain to be used to simply forward emails to another address without needing to configure an inbound email server/service

Become a Reseller

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/dom/domain/{domain_uuid}/email-forward

    Gets all active email forwards for the specific domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • domain_uuid

      • String

      • True

      The UUID of the domain to query the email forward for

    Response Details

    200 Response

    {
        "result" : [
            {
                "mailbox_name" : "postmaster",
                "destination_address" : "example@example.com",
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2018-09-20",
                "updated_on" : "2018-09-20"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/dom/domain/{domain_uuid}/email-forward/{uuid}

    Gets a specific email forward for the specified domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the email forward to query

      • domain_uuid

      • String

      • True

      The UUID of the domain to query the email forward for

    Response Details

    200 Response

    {
        "result" : {
            "mailbox_name" : "postmaster",
            "destination_address" : "example@example.com",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-09-20",
            "updated_on" : "2018-09-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/dom/domain/{domain_uuid}/email-forward

    Creates an email forward for the specific domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • domain_uuid

      • String

      • True

      The UUID of the domain to create the email forward for

    POST body

    • Name

    • Type

    • Required

      • destination_address

      • String

      • True

      The destination email address to forward the incoming message to

      • mailbox_name

      • String

      • True

      The name of the target email address to catch and forward for

    JSON all-fields example:

    {
        "mailbox_name" : "postmaster",
        "destination_address" : "example@example.com"
    }

    Response Details

    201 Response

    {
        "result" : {
            "mailbox_name" : "postmaster",
            "destination_address" : "example@example.com",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-09-20"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • PUT/dom/domain/{domain_uuid}/email-forward/{uuid}

    Updates the specified email forward for the specific domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • domain_uuid

      • String

      • True

      The UUID of the domain to update the email forward for

      • uuid

      • String

      • True

      The UUID of the email forward to be updated

    PUT body

    • Name

    • Type

    • Required

      • destination_address

      • String

      • True

      The destination email address to forward the incoming message to

      • mailbox_name

      • String

      • True

      The name of the target email address to catch and forward for

    JSON all-fields example:

    {
        "mailbox_name" : "postmaster",
        "destination_address" : "example@example.com"
    }

    Response Details

    200 Response

    {
        "result" : {
            "mailbox_name" : "postmaster",
            "destination_address" : "example@example.com",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-09-20",
            "updated_on" : "2018-09-20"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }

    409 Response

    {
        "result" : {},
        "status_code" : 409,
        "status_message" : "Conflict"
    }
  • DELETE/dom/domain/{domain_uuid}/email-forward/{uuid}

    Deletes the specified email forward for the specific domain

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • domain_uuid

      • String

      • True

      The UUID of the domain to delete the email forward for

      • uuid

      • String

      • True

      The UUID of the email forward to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    400 Response

    {
        "result" : {},
        "status_code" : 400,
        "status_message" : "Bad Request"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }