Skip to main content
Vindicia Knowledge Center

Update an Account

Update an Account

Update a specific Account. Any parameters provided will be updated, leaving other parameters unchanged.

Route (URL) Parameters

Parameter Default Description Required
account n/a The id or the vid of the Account to retrieve Yes

Query Parameters

None.

Accepts

JSON This request supports the same arguments as ‘create’ (a full Account object) excepting the behavior of the ids; providing an id or vid in the URL indicates to CashBox that this is an update, not a create – as such, id and vid cannot be updated.

Returns

JSON A full Account object representing the new version of the Account.

  • cURL
  • Java
Example Request
curl -X POST \
-u acaff38d462f9430d5cbcbaf:a575771fc679b9de \
-d '{
"email": "charlie.brown@example.com"
}' "https://api.prodtest.vindicia.com/accounts/cust_1234"
The above command returns JSON structured like this:
{
  "object": "Account",
  "id": "cust_1234",
  "vid": "f147870b2c86a00fb1264fb64c0a8b58fcd95b4d",
  "created": "2016-05-18T13:39:03-07:00",
  "default_currency": "USD",
  "email": "charlie.brown@example.com",
  "email_type": "html",
  "language": "EN-U",
  "notify_before_billing": true,
  "company": "Peanuts",
  "name": "Charlie Brown",
  "shipping_address": {
    "object": "Address",
    "vid": "dad524f59d1bd72f10a9162b7d7790caa39678dc",
    "name": "Charlie Brown",
    "line1": "123 Main Street",
    "city": "San Francisco",
    "district": "CA",
    "postal_code": "94105",
    "country": "US",
    "phone": "415-555-3212"
  },
  "metadata": {
  "favorite dog": "Snoopy",
  "favorite activity": "flying kites"
  }
}
import com.vindicia.client.CashBox;
CashBox.apiKey = "acaff38d462f9430d5cbcbafa575771fc679b9de";
Map<string,> params = new HashMap<string,>();
params.put("email", "charlie.brown@example.com");
params.put("id",    "cust_1234");
Account.update(params);
The above command returns JSON structured like this:
<
{
  "object": "Account",
  "id": "cust_1234",
  "vid": "f147870b2c86a00fb1264fb64c0a8b58fcd95b4d",
  "created": "2016-05-18T13:39:03-07:00",
  "default_currency": "USD",
  "email": "charlie.brown@example.com",
  "email_type": "html",
  "language": "EN-U",
  "notify_before_billing": true,
  "company": "Peanuts",
  "name": "Charlie Brown",
  "shipping_address": {
    "object": "Address",
    "vid": "dad524f59d1bd72f10a9162b7d7790caa39678dc",
    "name": "Charlie Brown",
    "line1": "123 Main Street",
    "city": "San Francisco",
    "district": "CA",
    "postal_code": "94105",
    "country": "US",
    "phone": "415-555-3212"
  },
  "metadata": {
    "favorite dog": "Snoopy",
    "favorite activity": "flying kites"
  }
}

For Users

Learn More
For Users

Cashbox Features

Learn More
Cashbox Features
Back to Top