Docs
Search docs...⌘K

Update Project

API only
PATCH/v3/management/update-project

Requests to this endpoint are free and do not consume any API units.

At least one of access or folder must be set.

Query parameters

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Request body

project_idintegerRequired

The ID of the project whose access setting you want to update. You can find it in the URL of your Rank Tracker project in Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#

folder

A folder operation, applied before the access change.
Keep in mind that moving a project to another folder may make it visible to members of the destination folder.

Remove project from its folder tree entirely.

operationstringrequired
Allowed values:remove
accessstring

The new access setting for the project.

Allowed values:privateshared

Responses

projectobject
accessstring

The access level of the project. Possible values: private, shared.

folderobject or null

Innermost folder that the project is in.

idinteger
namestring or null
modestring

The scope of the target. Possible values: exact, prefix, domain, subdomains.

project_idstring

The unique identifier of the project. You can find it in the URL of your Rank Tracker project in Ahrefs: https://app.ahrefs.com/rank-tracker/overview/#project_id#.

project_namestring

The project name.

protocolstring

The protocol of the target. Possible values: both, http, https.

urlstring (url)

The URL of the project's target.