{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "field": {
            "nullable": true,
            "description": "This empty field is returned instead of the list of scopes if the user making the call doesn't have the authorization required."
          },
          "message": {
            "type": "string",
            "description": "Explains why the scopes cannot be returned."
          }
        }
      },
      "description": "This 401 response indicates that the user making the call doesn't have the authorization to view the list of scopes."
    }
  }
}

{
  "type": "object",
  "required": [
    "scopes"
  ],
  "properties": {
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of scopes for which this user has access.",
      "uniqueItems": true
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "date",
      "stats"
    ],
    "properties": {
      "date": {
        "type": "string",
        "description": "The date the stats were gathered."
      },
      "stats": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "metrics": {
              "$ref": "#/components/schemas/stats-advanced-global-stats"
            }
          }
        },
        "description": "The individual email activity stats."
      }
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/subuser"
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "error_id": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/transactional-templates-template-lean"
      },
      "description": ""
    },
    "_metadata": {
      "$ref": "#/components/schemas/_metadata"
    }
  }
}

{
  "type": "object",
  "example": {
    "emails": [
      "example1@example.com",
      "example2@example.com"
    ],
    "delete_all": false
  },
  "properties": {
    "emails": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "email"
      },
      "description": "The list of specific email addresses that you want to remove."
    },
    "delete_all": {
      "type": "boolean",
      "description": "Indicates if you want to remove all email address from the invalid emails list."
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/invalid-email"
  },
  "description": "The list of invalid email addresses."
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/invalid-email"
  },
  "maxItems": 1,
  "minItems": 0,
  "description": "A specific invalid email."
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "example": {
    "ips": [
      {
        "ip": "192.168.1.1"
      },
      {
        "ip": "192.*.*.*"
      },
      {
        "ip": "192.168.1.3/32"
      }
    ]
  },
  "required": [
    "ips"
  ],
  "properties": {
    "ips": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "ip"
        ],
        "properties": {
          "ip": {
            "type": "string",
            "description": "An IP address that you want to allow."
          }
        }
      },
      "description": "An array containing the IP(s) you want to allow."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "result"
  ],
  "properties": {
    "result": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "allowed",
          "auth_method",
          "first_at",
          "ip",
          "last_at",
          "location"
        ],
        "properties": {
          "ip": {
            "type": "string",
            "description": "The IP addressed used during the access attempt."
          },
          "allowed": {
            "type": "boolean",
            "description": "Indicates if the IP address was granted access to the account."
          },
          "last_at": {
            "type": "integer",
            "description": "A Unix timestamp indicating when the most recent access attempt was made"
          },
          "first_at": {
            "type": "integer",
            "description": "A Unix timestamp indicating when the first access attempt was made."
          },
          "location": {
            "type": "string",
            "description": "The geographic location from which the access attempt originated."
          },
          "auth_method": {
            "type": "string",
            "description": "The authentication method used when attempting access."
          }
        }
      },
      "description": "An array containing the IPs that recently attempted to access your account."
    }
  }
}

{
  "type": "object",
  "example": {
    "ids": [
      1,
      2,
      3
    ]
  },
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "An array of the IDs of the IP address that you want to remove from your allow list."
    }
  }
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "object",
  "properties": {}
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "ip",
      "pools",
      "warmup",
      "start_date"
    ],
    "properties": {
      "ip": {
        "type": "string",
        "description": "The IP address."
      },
      "pools": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "The IP pools that this IP address has been added to."
      },
      "warmup": {
        "type": "boolean",
        "description": "Indicates if this IP address is currently warming up."
      },
      "start_date": {
        "type": "integer",
        "description": "The start date that this IP address was entered into warmup."
      }
    }
  },
  "title": "List all assigned IPs response"
}

{
  "type": "object",
  "required": [
    "ip",
    "subusers",
    "rdns",
    "pools",
    "warmup",
    "start_date",
    "whitelabeled"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "description": "The IP address."
    },
    "rdns": {
      "type": "string",
      "description": "The reverse DNS record for this IP address."
    },
    "pools": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The list of IP pools that this IP address belongs to."
    },
    "warmup": {
      "type": "boolean",
      "description": "Indicates if this IP address is currently warming up."
    },
    "subusers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The subusers that can send email using this IP address."
    },
    "start_date": {
      "type": "integer",
      "nullable": true,
      "description": "The date that the IP address was entered into warmup."
    },
    "whitelabeled": {
      "type": "boolean",
      "description": "Indicates if this IP address is associated with a reverse DNS record."
    }
  }
}

{
  "type": "object",
  "required": [
    "results"
  ],
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "remaining",
          "period",
          "price_per_ip"
        ],
        "properties": {
          "period": {
            "type": "string",
            "description": "The length of time until user can add more IPs."
          },
          "remaining": {
            "type": "integer",
            "description": "The number of IPs that can still be added to the user."
          },
          "price_per_ip": {
            "type": "number",
            "description": "The current cost to add an IP."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the IP address could not be added to the IP Pool."
          }
        }
      },
      "description": "The error returned."
    }
  }
}

{
  "type": "object",
  "example": {
    "ip": "0.0.0.0"
  },
  "properties": {
    "ip": {
      "type": "string",
      "description": "The IP address that you want to add to the named pool."
    }
  }
}

{
  "type": "object",
  "required": [
    "ip",
    "pools",
    "start_date",
    "warmup"
  ],
  "properties": {
    "ip": {
      "type": "string",
      "description": "The IP address."
    },
    "pools": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IP pools that this IP address has been added to."
    },
    "warmup": {
      "type": "boolean",
      "description": "Indicates if the IP address is in warmup."
    },
    "start_date": {
      "type": "integer",
      "description": "A Unix timestamp indicating when the warmup process began for the added IP address."
    }
  }
}

{
  "type": "object",
  "example": {
    "name": "marketing"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "The name of your new IP pool."
    }
  }
}

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "An error explaining why the pool could not be deleted."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ip_pool_response"
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "The name of the error."
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the IP addresses could not be listed."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "ips": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The IP addresses that belong to this pool."
    },
    "pool_name": {
      "type": "string",
      "maxLength": 64,
      "description": "The name of the IP pool."
    }
  }
}

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "An error explaining why the IP address could not be removed from the IP pool."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "example": {
    "name": "new_pool_name"
  },
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 64,
      "description": "The new name for your IP pool."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the name of your IP pool could not be updated."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the warmup status could not be retrieved."
          }
        }
      },
      "description": "The errors that were encountered."
    }
  }
}

{
  "type": "object",
  "example": {
    "ip": "0.0.0.0"
  },
  "properties": {
    "ip": {
      "type": "string",
      "description": "The IP address that you want to begin warming up."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the IP couldn't entered into warmup mode."
          }
        }
      },
      "description": "The errors that were encountered."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "nullable": true
          },
          "message": {
            "type": "string",
            "description": "A message explaining why the IP couldn't be removed from warmup."
          }
        }
      },
      "description": "The errors that were encountered."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "example": {
    "username": "jane@example.com"
  },
  "properties": {
    "username": {
      "type": "string",
      "description": "The username of the subuser account that you want to associate the branded link with."
    }
  }
}

{
  "type": "object",
  "example": {
    "domain": "example.com",
    "default": true,
    "subdomain": "mail"
  },
  "required": [
    "domain"
  ],
  "properties": {
    "domain": {
      "type": "string",
      "description": "The root domain for the subdomain that you are creating the link branding for. This should match your FROM email address."
    },
    "default": {
      "enum": [
        true,
        false
      ],
      "type": "boolean",
      "description": "Indicates if you want to use this link branding as the default or fallback. When setting a new default, the existing default link branding will have its default status removed automatically."
    },
    "subdomain": {
      "type": "string",
      "description": "The subdomain to create the link branding for. Must be different from the subdomain you used for authenticating your domain."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/link_branding_200_response"
  }
}

{
  "type": "object",
  "example": {
    "default": true
  },
  "properties": {
    "default": {
      "enum": [
        true,
        false
      ],
      "type": "boolean",
      "description": "Indicates if the branded link is set as the default. When setting a new default, the existing default link branding will have its default status removed automatically."
    }
  }
}

{
  "type": "object",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "message"
        ],
        "properties": {
          "message": {
            "type": "string",
            "description": "The reason why the link whitelabel could not be validated."
          }
        }
      },
      "description": "The reasons why the validation failed."
    }
  }
}

{
  "type": "object",
  "required": [
    "id",
    "valid",
    "validation_results"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the branded link."
    },
    "valid": {
      "enum": [
        true,
        false
      ],
      "type": "boolean",
      "description": "Indicates if the link branding is valid."
    },
    "validation_results": {
      "type": "object",
      "required": [
        "domain_cname"
      ],
      "properties": {
        "owner_cname": {
          "type": "object",
          "required": [
            "valid",
            "reason"
          ],
          "properties": {
            "valid": {
              "enum": [
                true,
                false
              ],
              "type": "boolean",
              "description": "Indicates if the DNS record is valid."
            },
            "reason": {
              "type": "string",
              "nullable": true,
              "description": "Null if valid. If the DNS record is invalid, this will explain why."
            }
          },
          "description": "The DNS record created to verify the branded link."
        },
        "domain_cname": {
          "type": "object",
          "required": [
            "valid",
            "reason"
          ],
          "properties": {
            "valid": {
              "enum": [
                true,
                false
              ],
              "type": "boolean",
              "description": "Indicates if this DNS record is valid."
            },
            "reason": {
              "type": "string",
              "nullable": true,
              "description": "Null if the DNS record is valid. If the DNS record is invalid, this will explain why."
            }
          },
          "description": "The DNS record generated for the sending domain used for this branded link."
        }
      },
      "description": "The individual validation results for each of the DNS records associated with this branded link."
    }
  }
}

{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "properties": {
    "contact_count": {
      "type": "integer"
    },
    "billable_count": {
      "type": "integer"
    }
  }
}

{
  "type": "object",
  "example": {
    "name": "list-name"
  },
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "description": "Your name for your list"
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/error"
      }
    }
  }
}