PATCH
/
accounts
/
{account_id}
curl --request PATCH \
  --url https://api.togai.com/accounts/{account_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "New Account Name",
  "primaryEmail": "admin@example.com",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina"
  }
}'
{
  "id": "G234DZZKBKACATFFGVGEMERFI",
  "togaiAccountId": "account.safdla.c234ds",
  "customerId": "ACME",
  "togaiCustomerId": "customer.savass.11e1a",
  "name": "ACME Enterprise - Account2",
  "invoiceCurrency": "USD",
  "address": {
    "phoneNumber": "+919876543210",
    "line1": "2281 Broadway Street",
    "line2": "G-31",
    "postalCode": "29501",
    "city": "Florence",
    "state": "South Carolina",
    "country": "US"
  },
  "primaryEmail": "admin@example.com",
  "aliases": [
    {
      "alias": "account2@acme.com"
    },
    {
      "alias": "+1234567890"
    }
  ],
  "status": "ACTIVE"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

account_id
string
required

account_id corresponding to an account

Body

application/json
name
string

Name of the Account

status
enum<string>
Available options:
ACTIVE,
DRAFT
invoiceCurrency
string

ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.

netTermDays
integer
primaryEmail
string

Primary email of the account

address
object

billing address of the customer

metadata
object

Additional information associated with the account. Example: GSTN, VATN NOTE: This replaces the existing metadata if the metadata in the request is not null. To remove all existing metadata, use empty object

tags
string[]

Tag for accounts are stored in lowercase

Response

200 - application/json
id
string
required

Identifier of the account

togaiAccountId
string
required

Unique identifier of the account

togaiCustomerId
string
required

Unique identifier of the customer

name
string
required

Name of the Account

customerId
string
required

Identifier of the customer

invoiceCurrency
string

ISO_4217 code of the currency in which the account must be invoiced Defaults to Base currency.

aliases
object[]

list of aliases of the account

netTermDays
integer
address
object

billing address of the customer

primaryEmail
string

Primary email of the customer

status
enum<string>
required

Status of the account

Available options:
ACTIVE,
DRAFT,
ARCHIVED
settings
object[]
invoiceGroupDetails
object

Invoice group details

metadata
object

Additional information associated with the account. Example: GSTN, VATN

tags
string[]

Tag for accounts are stored in lowercase