Documentation

Create, Update, or Delete a Project Tag

POST /projects/tags

Creates a new site-specific tag for the specified site, named according to the "name" parameter.

Request Body

Supply exactly one scope. To update or delete a tag, send its project_tag_id under the tag’s existing scope. A delete also requires delete: true.

Field Type Required Description
site_id string No* Site ID
user_id string No* User ID
portal_id string No* Portal ID
project_tag_id string No** Project tag ID
name string Yes** Tag name
color string No Tag color
public boolean No Public flag
delete boolean No Delete flag

* One of site_id, user_id, or portal_id is required.

** name is required if creating a new tag. project_tag_id is required if updating an existing tag.

Response

Success Response (200 OK)

data contains the created or updated tag. A successful delete returns a success envelope without data.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to create tags on this site or portal
  • 404 Not Found: Site, user, or portal with the specified ID does not exist

See the Projects API overview for related endpoints.