v1Resources/Connections/postMove a listing account to agency level

Move a listing account to agency level

Moves a client's Google or Facebook listing account up to agency level, so its listings can be assigned to locations of any client in your agency. Nothing reconnects and no one signs in again: the locations the account already serves stay connected through the same sign-in. If your agency already has an agency-level account for the same Google or Facebook sign-in, this one merges into it. Its listings and ad accounts move to the existing account, and the account you moved is archived. Send dryRun as true first to see what would happen without changing anything. This needs a token with access to every client; a token limited to specific clients gets 403. Returns 400 for anything other than a Google or Facebook listing account (brand-level social accounts and a single location's connection can't move), 404 when the connection doesn't exist or is archived, and 409 when the account is already at agency level.

post/api/v1/connections/move-to-agency
connections:write
Request body
connectionIdstringrequired
The id of the listing account to move. Use the account's own connection, not the connection of one of its locations.
dryRunbooleanoptional
Set to true to preview the move without making it. The response has the same fields, minus moved.
Response
dataobjectoptional
movedboolean (true)optional
Always true after a real move. Not included in a dry run.
accountIdstringoptional
The account you asked to move. After a merge, this account is archived and mergeIntoId is the account to use from then on.
mergeIntoIdstringoptional
The existing agency-level account this one merges into, or null when the account moves on its own.
mergeIntoNamestringoptional
The display name of the account it merges into, or null when there is no merge.
locationCountintegeroptional
How many connected locations the account serves, counted before the move.
clientCountintegeroptional
How many clients those locations belong to.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/connections/move-to-agency
Your API key
Request body*
{}

Guides that use this resource