View a specific email - HelpYouSponsor Docs

GET

admin

emails

{email_id}

View a specific email

curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/emails/{email_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "email": {
    "id": 123,
    "status": 123,
    "to": "<string>",
    "from_name": "<string>",
    "from": "<string>",
    "subject": "<string>",
    "message": "<string>",
    "date": "<string>",
    "admin_assigned": 123
  },
  "admins": [
    {
      "id": 123,
      "name": "<string>",
      "email": "<string>"
    }
  ],
  "responses": [
    {}
  ],
  "disabled": "<string>"
}

Authorizations

X-HYS-API-Key

string

header

required

API key generated from Developer Settings. Format: hys_...

Path Parameters

email_id

integer

required

The id of the email to view

Response

Successful operation

object

The email object

Show child attributes

admins

object[]

The list of admins

Show child attributes

responses

object[]

The responses to the email

disabled

string

Disabled status of the email

View email manager

View a specific email

curl --request GET \
  --url https://api.helpyousponsor.com/v1/admin/emails/{email_id} \
  --header 'X-HYS-API-Key: <api-key>'

{
  "email": {
    "id": 123,
    "status": 123,
    "to": "<string>",
    "from_name": "<string>",
    "from": "<string>",
    "subject": "<string>",
    "message": "<string>",
    "date": "<string>",
    "admin_assigned": 123
  },
  "admins": [
    {
      "id": 123,
      "name": "<string>",
      "email": "<string>"
    }
  ],
  "responses": [
    {}
  ],
  "disabled": "<string>"
}