Back to top

Emails

Email Management

Create an email
/emails

Add a new email address to the current user.

  • Parameters
  • email
     (required) in body

    Email to create

    {
    	"address": "string",
    	"default": "boolean"
    }
  • Response  201   created
  • {
    	"id": "string",
    	"address": "string",
    	"default": "boolean",
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Retrieve an email
GET
/emails/{id}

Provides one of the user’s emails.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"address": "string",
    	"default": "boolean",
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the email
PUT
/emails/{id}

Updates the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    email
     (required) in body

    email to update

    {
    	"address": "string",
    	"default": "boolean"
    }
  • Response  200   ok
  • {
    	"id": "string",
    	"address": "string",
    	"default": "boolean",
    	"href": "string"
    }
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the email
/emails/{id}

Deletes the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found