Register an email sender

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "api_secret": {
      "type": "string"
    },
    "application_ids": {
      "type": "object",
      "description": "An optional array of additional ApplicationID's that the value is to be assigned to.",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string",
      "description": "An optional name to be attached to this binding"
    },
    "provider": {
      "type": "string",
      "format": "enum",
      "description": "The delivery method by which the value would be assigned. Always `email`",
      "enum": [
        "email"
      ]
    },
    "value": {
      "type": "string",
      "format": "email",
      "description": "The email adress to attach to the application(s)"
    }
  },
  "required": [
    "api_secret",
    "provider",
    "value"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "application_ids": {
      "type": "array",
      "description": "An array of ApplicationID strings attached to the value provided.",
      "items": {
        "type": "string"
      }
    },
    "name": {
      "type": "string",
      "description": "An optional name to be attached to this binding"
    },
    "provider": {
      "type": "string",
      "format": "enum",
      "description": "Enum identifer of provider type.",
      "enum": [
        "email"
      ]
    },
    "value": {
      "type": "string",
      "description": "Value given to the provider to attach to the Application IDs."
    }
  }
}