Backstack - Account

The current session account.

The Account object

// account object
{
  "id": "acc_1234567890",
  ...
  "domain_id": "dom_1234567890",
  "version_id": "ver_1234567890",
  ...
}

Property	Type	Description
`id`	String	The account ID.
`created`	Integer	The timestamp of the account creation.
`title`	String	The title of the account.
`address`	String	The street address for the account.
`city`	String	The address city.
`state`	String	The address state.
`zip`	String	The address zip code.
`phone`	String	The phone number for the account.
`url`	String	The URL for the account website.
`contact_name`	String	The contact name for the account.
`contact_email`	String	The contact persons email address.
`timezone_id`	String	The account timezone ID.
`country_id`	String	Required country ID.
`is_app_account`	Boolean	Whether the account created the app.
`domain_id`	String	The domain ID for which the account was created.
`version_id`	String	The current `domain.version` for which the account is operating.

Create an account

Accounts are created using the sign-up and account network workflows.

Read an account

Retrieves the current session Account object.

Request

GET /v1/auth/account

Response

The Account object.

You can read the session.account to get an extended version of the account object.

Update an account

Updates the current session Account object.

Request

POST /v1/auth/account
{
  "title": "Acme Corp"
  ...
}

Parameter	Type	Note
`title`	Required string
`address`	Optional string
`city`	Optional string
`state`	Optional string
`zip`	Optional string
`phone`	Optional string
`url`	Required string
`contact_name`	Required string
`contact_email`	Optional string
`timezone_id`	Optional string	See the timesones resource for more information.
`country_id`	Required string	See the countries resource for more information.

The API updates only the parameters that are submitted. Submitting an empty value deletes a parameter. If a required value is empty, the existing value is retained.

Response

The Account object.

Delete an account

Deletes an account and expires the session.

Request

DELETE /v1/auth/account

Response

Returns the deleted account id.