v1Resources/Connections/postArchive a boost config
Archive a boost config
Archives a saved boost configuration so it no longer appears as a reusable preset. Does not affect any boost already in progress that was created from it.
post
connections:write/api/v1/connections/boost-configs/archiveRequest body
connectionIdstringrequired
The connected account that owns the boost config. Required. Look it up with GET /api/v1/connections.
configIdstringrequired
The boost config to archive. Must belong to connectionId. Required.
Response
dataobjectoptional
archivedbooleanoptional
Always true on success.
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.
429Too many requests. Retry after the number of seconds in the Retry-After header.
post/api/v1/connections/boost-configs/archive
Your API key
Request body*
{
"data": {
"archived": true
}
}