Post Card Lead Intake API

PSOnline supports an API for adding postcard leads to a client system.

https://app.periodicalservices.com/api/postcards/v1.0/

Please note, the version number in the URL may change to support newer features, but older versions will be kept for backwards compatibility.

Please submit standard name=value pairs via the POST HTTP method.

The following fields are required:

Client= The system ID of the PSOnline client you're submitting to

LeadSource= The 2-character lead source code you have been assigned by your receiving client

FirstName= The lead's first name

LastName= The lead's last name

AddressOne= The lead's street address

City= The lead's city

State= The lead's state (2-character abbreviation)

Zip= The lead's 5-digit ZIP code

The following fields are optional:

Email= The lead's email address

PhoneNumber= The lead's phone number

Responses are provided in JSON format.

A successful response will look like this:

{
	status: "ok",
	reason: "",
	inserted: true,
	address_key: "",
	claim_number: "",
	standardized_address_one: "",
	standardized_address_two: "",
	standardized_city: "",
	standardized_state: "",
	standardized_zip: "",
	standardized_plusfour: ""
}

A status of “ok” indicates success. Other possible values are “malformed”, “rejected”, “suppressed”, and “duplicate”

The “reason” field will contain a human-readable message in the event of a “malformed” or “rejected” status.

The “inserted” field is a boolean that will indicate if database insertion was successful.

The “address_key” field will contain the unique USPS indicator for the lead’s delivery box.

The “standardized_*” fields will contain the USPS-standardized address details for the lead’s delivery box.

Version 1.0

Initial release