# Radius Mail

Initiate a Radius Mail order centered around the list of provided addresses. Each address in the list will initiate a Radius Mailing with the provided filter settings. Recipients will be queried and added to the provided integration order.

Endpoint: POST /v1/integration-orders/{id:int}:mail-by-proximity
Version: 1.0.0
Security: apikey

## Path parameters:

  - `id` (integer, required)
    ID of integration order add recipients to.

## Request fields (application/json):

  - `name` (string)

  - `ownerOrRenterFilter` (integer,null)
    Enum: 0, 1

  - `propertyTypeFilter` (integer,null)
    Enum: 0, 1, 2

  - `houseHoldIncomeFilter` (object)

  - `houseHoldIncomeFilter.min` (integer,null)

  - `houseHoldIncomeFilter.max` (integer,null)

  - `lengthOfResidenceFilter` (object)

  - `yearBuiltFilter` (object)

  - `addresses` (array)

  - `addresses.address1` (string)

  - `addresses.address2` (string)

  - `addresses.city` (string)

  - `addresses.state` (string)

  - `addresses.zip` (string)

  - `addresses.desiredCount` (integer)

  - `multiUse` (boolean,null)

## Response 200 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)

## Response 400 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)

## Response 401 fields (application/json):

  - `profile` (object)

  - `profile.id` (integer)
    Account ID

  - `profile.aadId` (string)
    Account AAD ID

  - `profile.email` (string)
    Account Email

  - `profile.firstName` (string)
    Account First Name

  - `profile.lastName` (string)
    Account Last Name

  - `profile.company` (string)
    Account Company

  - `profile.created` (string)
    Account Created Date

  - `profile.shouldProcessQrCodes` (boolean)
    Account Setting - Should Process QR Codes

  - `payload` (object)

  - `payload.id` (integer)
    Integration Order ID

  - `payload.name` (string)
    Integration Order Name

  - `payload.createdDate` (string)
    Integration Order Created Date

  - `payload.updatedDate` (string)
    Integration Order Updated Date

  - `payload.postageType` (string)
    Integration Order Postage Type. FirstClass or Standard.

  - `payload.integrationOrderStatus` (string)
    Integration Order Status. Pending, In Progress, Completed, Failed, Cancelled.

  - `errors` (array)

  - `hasErrors` (boolean)

  - `warnings` (array)

  - `hasWarnings` (boolean)

  - `metadata` (object)