POST Household/CreateHouseholdWithAccount?householdName={householdName}&account={account}&Line1={Line1}&Line2={Line2}&City={City}&State={State}&Zipcode={Zipcode}

Creates the household with account. If no address being provided, don't pass any of the required address fields. Otherwise you must pass all of them. Returns the id of the just created household

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
householdName

Name of the household. If longer than 60 characters, it will be truncated to 60.

string

Required

account

The account.

string

Required

Line1

The standard street address

string

Field required with all others labeled similarly, or all must be left blank

Line2

The special identifier (apartment number, office suite, etc.)

string

None.

City

The city

string

Field required with all others labeled similarly, or all must be left blank

State

The state

string

Field required with all others labeled similarly, or all must be left blank

Zipcode

The zip code

string

Field required with all others labeled similarly, or all must be left blank

Body Parameters

None.

Response Information

Resource Description

Type: integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>