v1Resources/Clients/patchUpdate a publisher set

Update a publisher set

Owners/admins with Clients access manage publisher sets. Agency-wide members can list assignment choices and assign sets to accessible clients. Client-restricted credentials are refused. Empty siteIds excludes every directory; sets cannot expand agency entitlements. Updates require the current revision and at least one changed field. Assigned sets cannot be deleted. Assignment is atomic and queues background listing adjustments.

patch/api/v1/publisher-sets/{id}
clients:write
Query parameters
idstringrequired
Publisher set ID.
Request body
namestringoptional
Unique name, up to 100 characters.
siteIdsarray of integeroptional
Complete selection of directory IDs. An empty array excludes all directories.
revisionintegerrequired
Current revision returned by a read. Stale revisions are refused.
Response
dataobjectoptional
publisherSetobjectoptional
idstringoptional
namestringoptional
Unique name, up to 100 characters.
siteIdsarray of integeroptional
Complete selection of directory IDs. An empty array excludes all directories.
revisionintegeroptional
Current revision returned by a read. Stale revisions are refused.
createdAtstringoptional
updatedAtstringoptional
clientCountintegeroptional
adjustmentstringoptional
affectedClientsintegeroptional
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 name is taken, the revision is stale, or the set is still assigned.
429Too many requests. Retry after the number of seconds in the Retry-After header.
patch/api/v1/publisher-sets/{id}
Your API key
id *
Request body*
{}

Guides that use this resource