Accounts

Remove Aliases to account

Remove existing aliases tagged to an account using this API

post/accounts/{account_id}/remove_aliases

Request

Base URL
https://api.togai.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/togaihq/apis/togai-apis/docs/accounts/:account_id/remove_aliases/post.ts
A function with typed inputs. Its response is checked against the schema.

account_idstring required

Example:ACC00001

account_id corresponding to an account

aliasesstring[]

Response for Create and Get account requests

idstring required

Identifier of the account

togaiAccountIdstring required

Unique identifier of the account

togaiCustomerIdstring required

Unique identifier of the customer

namestring required

Name of the Account

customerIdstring required

Identifier of the customer

invoiceCurrencystring

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

netTermDaysinteger

primaryEmailstring

Primary email of the customer

status'ACTIVE' | 'DRAFT' | 'ARCHIVED' required

Status of the account

metadataobject

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

tagsstring[]

Tag for accounts are stored in lowercase

{
  "invoiceCurrency": "USD",
  "primaryEmail": "admin@example.com",
  "status": "ACTIVE"
}

Mar 18, 20243135bb8c67b3 Revision changes
- info
  added the optional property to the response with the status
Mar 1, 20246fb940b0dad9 Revision changes
- breaking
  the response property became optional for the status
- breaking
  the response property's maxLength was increased from 255 to 320 for the response status
- warning
  added the new DRAFT enum value to the response property for the response status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status