Add-TagsToProject

  • 1 minute(s) read
Prev Next

Summary

Adds tags to an existing project. Can replace all tags or append new ones.

Add-TagsToProject
    -Id
    -TagIds
    -Append

Returns nothing.

Parameters

Parameter

Type

Required?

Notes

Id

Int64

Yes

The project id.

TagIds

Array<Int32>

Yes

An array of tag ids.

Append

Switch

No, Defaults to false

If provided, the command will append the list of tag ids to the existing tags, otherwise the tags will be replaced with the list of tag ids.

Examples

Append tags to a project

# Append a set of tags to a project
Add-TagsToProject `
    -Id 2026010000001 `
    -TagIds @(
        19, # Tag: "Training"
        30  # Tag: "Document Review"
    ) `
    -Append

$project = Get-Project -Id 2026010000001

# Output some information to help indicate that the tags were added
Write-Output "Appended tags to project '$($project.Description)' (Id: #$($project.ProjectId), Status: $($project.Status), Tags: $($project.ComputedTags))"

# For debug purposes, convert the data to output as JSON so we can see all the fields
Write-Output ""
Write-Output "JSON Results:"

$jsonOutput = $project | ConvertTo-Json -Depth 10

# Output the data
Write-Output $jsonOutput

Execution results:

Appended tags to project 'Archive Relativity Workspace' (Id: #2026010000001, Status: New, Tags: Document Review; Training)

JSON Results:
{
  "ProjectId": 2026010000001,
  "ProjectTypeId": 1,
  "ProjectTypeName": "Normal",
  "ProjectTypeDescription": "The normal project type where task work is performed.",
  "ProjectSourceTypeId": 1,
  "ProjectSourceTypeName": "Not Specified",
  "MatterId": 39,
  "Matter": null,
  "MatterName": "AGM Widget Corp. vs. MGM Manufacturing Inc.",
  "MatterReference": "1024-0002",
  "ClientId": 29,
  "Client": null,
  "ClientName": "AGM Widget Corporation",
  "ClientReference": "1024",
  "ContactId": null,
  "Contact": null,
  "ContactFullName": null,
  "PricingAgreementOptionId": 1,
  "PricingAgreementOptionName": "Standard Pricing",
  "OwnedById": null,
  "OwnedBy": null,
  "OwnedByFullName": null,
  "Priority": "Normal",
  "DateReceived": "2026-01-19T15:43:50.6669099+00:00",
  "DateDue": null,
  "DateInvoiced": null,
  "NumberOfTasks": 0,
  "NumberOfUnassignedTasks": 0,
  "NumberOfBillingEntries": 0,
  "NumberOfVolumes": 0,
  "NumberOfMediaLogEntries": 0,
  "TotalWeight": 0,
  "CurrentWeight": 0,
  "Status": "New",
  "Description": "Archive Relativity Workspace",
  "Assignees": null,
  "IsApproved": false,
  "IsLate": false,
  "IsCompleted": false,
  "IsCanceled": false,
  "EmailNotificationsEnabled": false,
  "CompletedOn": null,
  "Tags": [],
  "ComputedTags": "Document Review; Training",
  "CreatedByFullName": "Max Miller",
  "CreatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "CreatedOn": "2026-01-19T15:43:50.8040195+00:00",
  "CreatedBy": null,
  "LastUpdatedByFullName": "Max Miller",
  "LastUpdatedById": "510e109b-6ff5-4442-9670-cd5e3cd82a7a",
  "LastUpdatedOn": "2026-01-19T16:29:07.7832424+00:00",
  "LastUpdatedBy": null,
  "Settings": null
}