Skip to main content
POST
/
accounts
/
{account_id}
/
add_aliases
Add Aliases to account
curl --request POST \
  --url https://api.togai.com/accounts/{account_id}/add_aliases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aliases": [
    "account2@acme.com",
    "+1234567890"
  ]
}
'
{
  "id": "G234DZZKBKACATFFGVGEMERFI",
  "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",
      "status": "ACTIVE"
    },
    {
      "alias": "+1234567890",
      "status": "ACTIVE"
    }
  ],
  "status": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

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

Maximum string length: 50
Example:

"ACC00001"

Body

application/json

Payload to add aliases to account

Payload to add aliases from account

​
aliases
string[]

List of aliases to add

Required array length: 1 - 10 elements
Required string length: 3 - 50
​
accountAliases
object[]

List of account aliases to add

Required array length: 1 - 10 elements

Response

Response for Create and Get account requests

Structure of an account

​
id
string
required

Identifier of the account

Maximum string length: 50
​
name
string
required

Name of the Account

Required string length: 3 - 255
​
customerId
string
required

Identifier of the customer

​
invoiceCurrency
string
required

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

Required string length: 3
Example:

"USD"

​
status
enum<string>
required

Status of the account

Available options:
ACTIVE,
ARCHIVED
Example:

"ACTIVE"

​
aliases
AccountAliases · object[]

list of aliases of the account

Maximum array length: 10
​
address
object

billing address of the customer

​
primaryEmail
string

Primary email of the customer

Maximum string length: 255
Example:

"admin@example.com"

​
settings
object[]
Maximum array length: 10
​
invoiceGroupDetails
object

Invoice group details

​
metadata
object

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