Linked Accounts | Hitchhikers Platform

Overview

Many of the interactions with the Knowledge Network such as listings sync, review response, or posting require authorization to be in place between Yext and a publisher. This authorization takes the form of OAuth and is stored as a Linked Account; a link between the Yext platform and a third party platform such as Google, Facebook, or Trustpilot. To manage the authorization Yext has over taking action on your behalf with third party platforms, use the Linked Accounts APIs.

LinkedAccounts: List and Get will return one or more Linked Accounts currently in place in your Yext account
LinkedAccounts: Assign can be used to indicate a given Linked Account should be used for a certain entity. This is important if you have multiple authorizations set up for the same third party. For example, Entity 123 could use Google My Business Account for Brand A while Entity 456 could use Google My Business Account for Brand B.

Use Cases

Return one or more Linked Accounts currently in place in your Yext account
indicate a given Linked Account should be used for a certain entity

Reference Docs

Linked Accounts Endpoints

LinkedAccounts: List

Lists all linked accounts in an account.

path Parameters

accountId

required

string

query Parameters

entityIds	Array of strings When provided, only linked accounts assigned to the specified entities will be returned.
publisherIds	Array of strings When provided, only linked accounts for the specified sites will be returned.
statuses	Array of strings Items Enum: "VALID" "INVALID" Defaults to all statuses. When specified, only linked accounts with the provided statuses will be returned.
pageToken	string If a response to a previous request contained the `nextPageToken` field, pass that field's value as the `pageToken` parameter to retrieve the next page of data.
limit	integer <= 50 Default: 10 Number of results to return.
offset	integer Default: 0 Number of results to skip. Used to page through results. Cannot be used together with `pageToken`.
v required	string A date in `YYYYMMDD` format.

Responses

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
},
"response": {"count": 0,
"nextPageToken": "string",
"linkedAccounts": [{"id": "string",
"publisherId": "string",
"entityIds": ["string"
],
"firstName": "string",
"lastName": "string",
"email": "string",
"status": "string",
"canAssign": true
}
]
}
}

LinkedAccounts: Get

Get details for an linked account.

path Parameters

accountId required	string
linkedAccountId required	string

query Parameters

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": {"id": 3955191,
"publisherId": "GOOGLEMYBUSINESS",
"entityIds": ["3492378"
],
"firstName": "John",
"lastName": "Doe",
"email": "johndoe@email.com",
"status": "VALID",
"canAssign": true
}
}

LinkedAccounts: Assign

Copy an eligible Linked Account from the top-level parent account to a subaccount. Optionally assign the Linked Account to an entity in the subaccount.

This functionality is only available for certain Yext accounts. Please reach out to your Yext representative for more information.

path Parameters

accountId required	string
linkedAccountId required	string

query Parameters

required

string

A date in YYYYMMDD format.

Request Body schema: application/json

destinationAccountId required	string The destination account ID that the linked account will be copied to.
entityIds	Array of strings The IDs of the entities that the linked account will be assigned to. The entity IDs must belong to the destination account ID. entityIds is required in order to copy and assign the Linked Account to the destination account ID.

Responses

Request samples

Payload

Content type

application/json

{"destinationAccountId": "string",
"entityIds": ["string"
]
}

Response samples

200
default

Content type

application/json

{"meta": {"uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
"errors": [ ]
},
"response": {"linkedAccountId": 512353
}
}