/from_addresses/{id}

Use this resource to view a single From Address.

Secured By: Authentication Token
Description:

view a From Address.

Headers

Name Required Type Description
X-AUTH-TOKEN * string

An authentication token provided to you by GovDelivery.

Status

Body

Format: application/json

Example
{
  "id": "2",
  "from_email": "others@sink.govdelivery.com",
  "from_name": "Weather Bot",
  "reply_to_email": null,
  "bounce_email": "errors-to@sink.govdelivery.com",
  "is_default": false,
  "created_at": "2016-06-06T17:04:29Z",
  "_links": {
    "self": "/from_addresses/2"
  }
}
Schema
Object that may include:
Name Type Description
id string

unique identifier for this resource

Example

1
from_email string

Email sender (from email)

Example

testing-from@sink.govdelivery.com
from_name string

Display name of the sender

Example

Weather Bot
reply_to_email string

Reply-To email. Optional, default is null.

Example

reply-to@sink.govdelivery.com
bounce_email string

Errors-To email. Optional, default is null.

Example

errors-to@sink.govdelivery.com
is_default boolean

true if this is the account’s default from address, false otherwise.

Example

true
created_at string

The date and time when the from address was created.

Example

2016-06-06T17:45:27Z
_links object

An object that defines links to related objects.

Properties

{
  "self": {
    "description": "Relative URI of the object",
    "type": "string",
    "example": "/from_addresses/1"
  }
}
 
{
  "title": "From Address",
  "type": "object",
  "properties": {
    "id": {
      "description": "unique identifier for this resource",
      "type": "string",
      "example": "1"
    },
    "from_email": {
      "description": "Email sender (from email)",
      "type": "string",
      "example": "testing-from@sink.govdelivery.com"
    },
    "from_name": {
      "description": "Display name of the sender",
      "type": "string",
      "example": "Weather Bot"
    },
    "reply_to_email": {
      "description": "Reply-To email. Optional, default is null.",
      "type": "string",
      "example": "reply-to@sink.govdelivery.com"
    },
    "bounce_email": {
      "description": "Errors-To email. Optional, default is null.",
      "type": "string",
      "example": "errors-to@sink.govdelivery.com"
    },
    "is_default": {
      "description": "true if this is the account's default from address, false otherwise.",
      "type": "boolean",
      "example": true
    },
    "created_at": {
      "description": "The date and time when the from address was created.",
      "type": "string",
      "example": "2016-06-06T17:45:27Z"
    },
    "_links": {
      "title": "Relational Links",
      "description": "An object that defines links to related objects.",
      "type": "object",
      "properties": {
        "self": {
          "description": "Relative URI of the object",
          "type": "string",
          "example": "/from_addresses/1"
        }
      }
    }
  }
}

Body

Format: application/json

Example
{
  "error": "Invalid authentication token"
}