loading

Accounts API Endpoints | Hitchhikers Platform

Overview

The Accounts Administrative API endpoint group is used to manage Yext accounts and sub-accounts.

Use Cases
  • Create sub-accounts
  • Get details for an account
  • Retrieve a list of all accounts you have access to
Reference Docs

Accounts: Create Sub-Account

Request to create a new empty sub-account under this account.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
newSubAccountId
required
string

The external sub-account ID for the new sub-account.

newSubAccountName
required
string

The name for the new sub-account.

countryCode
required
string

The country code for the new sub-account.

Responses

Request samples

Content type
application/json
{
  • "newSubAccountId": "B093879",
  • "newSubAccountName": "Yext Sub-Account",
  • "countryCode": "US"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Accounts: List

List all accounts that you have access to. Unless you are in Partner Portal mode, this will only be your own account.

query Parameters
v
required
string

A date in YYYYMMDD format.

name
string

Returns only accounts whose name contains the provided string

limit
integer <= 1000
Default: 100
offset
integer
Default: 0

Number of results to skip. Used to page through results. Cannot be used together with pageToken.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Accounts: Get

Get details for an account

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Accounts: Update

Update an account's name or ID

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
accountId
string

New ID of the account

accountName
string

New name of the account

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "accountName": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}