Appearance
Account
DANGER
This document has not been updated since version 0.0.3 and is not ready for production. It will be updated before version 1.0 of the project is released.
The current session account.
The Account object
json
// account object
{
"id": "acc_1234567890",
...
"domain_id": "dom_1234567890",
"version_id": "ver_1234567890",
...
}
Create an account
Accounts are created using the sign-up and account network workflows.
Read an account
Retrieves the current session Account object.
Request
sh
GET /v1/account
Response
The Account object.
TIP
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
sh
POST /v1/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 timezones resource for more information. |
country_id | Required string | See the countries resource for more information. |
TIP
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
sh
DELETE /v1/account
Response
Returns the deleted account id
.