Accounts | Hitchhikers

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

Payload

Content type

application/json

{"newSubAccountId": "B093879",
"newSubAccountName": "Yext Sub-Account",
"countryCode": "US"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"newSubAccountId": "B093879",
"newSubAccountName": "Yext Sub-Account",
"countryCode": "US"
}
}

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

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"count": 1,
"accounts": [{"accountId": "1264805",
"locationCount": 11,
"subAccountCount": 0,
"accountName": "Yext Demo Account",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhone": "1234567890",
"contactEmail": "johndoe@email.com"
}
]
}
}

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

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"accountId": 1264805,
"locationCount": 11,
"subAccountCount": 0,
"accountName": "Yext Demo Account",
"contactFirstName": "John",
"contactLastName": "Doe",
"contactPhone": "1234567890",
"contactEmail": "johndoe@email.com"
}
}

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

Payload

Content type

application/json

{"accountId": "string",
"accountName": "string"
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"id": "string"
}
}