Account Aliases
Remove Aliases to account
Remove existing aliases tagged to an account using this API
POST
/
accounts
/
{account_id}
/
remove_aliases
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
account_id
string
requiredaccount_id corresponding to an account
Body
application/json
Payload to remove account aliases
aliases
string[]
accountAliases
object[]
Response
200 - application/json
Structure of an account
id
string
requiredIdentifier of the account
togaiAccountId
string
requiredUnique identifier of the account
togaiCustomerId
string
requiredUnique identifier of the customer
name
string
requiredName of the Account
customerId
string
requiredIdentifier 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>
requiredStatus 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