Skip to content
Equnix Metal
show

Emails copied!

Email Management

Create an email copied!

POST
/emails

Add a new email address to the current user.

  • Parameters
  • email
     (required) in body

    Email to create

    address

    {
        "address": "string"
    }

Retrieve an email copied!

GET
/emails/{id}

Provides one of the user’s emails.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the email copied!

PUT
/emails/{id}

Updates the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    email
     (required) in body

    email to update

    {
        "default": "boolean"
    }

Delete the email copied!

DELETE
/emails/{id}

Deletes the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID