PATCH
/
accounts
/
{id}
{
  "name": "GoJo"
}

{
  "id": "ywgWhtGp",
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "id": "OLgPyqFF",
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "id": "FdqPzqFG",
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ],
  "createdAt": "2023-09-05T21:54:54.609688Z",
  "updatedAt": "2023-09-05T21:54:54.609689Z"
}

{
  "name": "GoJo"
}

You can provide one or more of the following fields to update them, any fields not provided will be left unchanged.

​
Params

​
id
string

The ID of the account to update.

​
Request

{
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ]
}
​
name
string
required

The name of the account.

​
aliases
[]string

The list of alternative or external IDs for the account. These can be used to identify the account in place of the Alguna id.

​
contacts
[]Contact

The contacts associated with the account.

​
billingAddress
Address
required

The billing address for the account.

​
currency
string
required

The currency in which the account will be billed. This must be a valid ISO 4217 currency code.

​
Response

{
  "id": "ywgWhtGp",
  "name": "GoJo",
  "aliases": ["JoGo"],
  "currency": "USD",
  "billingAddress": {
    "line1": "123 Main St",
    "line2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001"
  },
  "contacts": [
    {
      "id": "OLgPyqFF",
      "email": "sales@gojo.com",
      "firstName": "Henry",
      "lastName": "Sules",
      "isPrimary": true,
      "emailPreferences": ["updates"]
    },
    {
      "id": "FdqPzqFG",
      "email": "finance@gojo.com",
      "firstName": "Accounts",
      "lastName": "Receivable",
      "isPrimary": false,
      "emailPreferences": ["billing"]
    }
  ],
  "createdAt": "2023-09-05T21:54:54.609688Z",
  "updatedAt": "2023-09-05T21:54:54.609689Z"
}
​
id
string

The Alguna ID of the account.

​
name
string

The name of the account.

​
aliases
[]string

The list of alternative or external IDs for the account. These can be used to identify the account in place of the Alguna id.

​
contacts
[]Contact

The contacts associated with the account.

​
billingAddress
Address

The billing address for the account.

​
currency
string

The ISO 4217 currency in which the account is billed.

​
createdAt
datetime

The date and time at which the account was created.

​
updatedAt
datetime

The date and time at which the account was last updated.