Update board identity fields.
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Patch, RequestUri = new Uri("https://example.com/api/workspace/admin/boards/boards/example"), Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"RowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"TagsEnabled\": true, \"BoardType\": 0, \"BoardCycleActivationMode\": 0 }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/boards/boards/example';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"Key":"example","DisplayName":"example","Description":"example","RowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","TagsEnabled":true,"BoardType":0,"BoardCycleActivationMode":0}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/api/workspace/admin/boards/boards/example \ --header 'Content-Type: application/json' \ --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "RowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "TagsEnabled": true, "BoardType": 0, "BoardCycleActivationMode": 0 }'Authorizations
Section titled “Authorizations”- None
Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Request Body
Section titled “Request Body”Updates board identity fields.
object
Required stable board key.
Board display name.
Board description.
Required expected board row version.
Optional replacement tag setting. Null preserves the current setting.
Updates board identity fields.
object
Required stable board key.
Board display name.
Board description.
Required expected board row version.
Optional replacement tag setting. Null preserves the current setting.
Updates board identity fields.
object
Required stable board key.
Board display name.
Board description.
Required expected board row version.
Optional replacement tag setting. Null preserves the current setting.
Responses
Section titled “Responses”OK
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0 } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Bad Request
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0 } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
object
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}Not Found
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0 } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Conflict
object
Full board administration model.
object
Board id.
Stable board key.
Owned Part EntityDefinition id used for board payload data.
Board display name.
Board description.
Whether the board can be used for runtime process activity.
Whether board item tags are enabled.
Full board due-date administration policy.
object
Board due-date status expectation administration row.
object
Board AttentionSignal projection and delivery policy.
object
One configured board AttentionSignal reason row.
object
One configured audience subject for board AttentionSignals.
object
Allowed actions for one board.
object
Whether board identity can be updated.
Whether board can be deleted.
Whether board can be activated.
Whether board can be deactivated.
Whether board configuration can be changed.
Canonical target definitions.
Canonical board target definition.
object
Board statuses.
Board status administration model.
object
Status id.
Optional stable status key.
Status display name.
Status description.
Status visual color token.
Display order.
Whether the status can receive board items.
Whether the status is retained only for history.
Soft-delete timestamp.
User id that soft-deleted the status.
Soft-delete reason.
Current board items in this status.
Movement history rows referencing this status.
Allowed actions for one board status.
object
Whether the status can be updated.
Whether the status can be deleted.
Status row version.
Board transition matrix rows.
Board transition administration model.
object
Transition id.
Optional stable transition key.
Source status id.
Target status id.
Transition display name.
Display order within the source status.
Whether the transition is available.
Allowed actions for one board transition.
object
Whether the transition can be updated.
Whether the transition can be deleted.
Transition row version.
Required active-link scopes for this transition.
One configured active-link prerequisite for a board transition.
object
Prerequisite id.
Required target board id.
Required target definition id.
Minimum matching active-link count.
Optional maximum matching active-link count.
Prerequisite row version.
Number of open board items.
Total number of board items.
Total number of board cycles.
Board row version.
object
object
object
object
Example
{ "Data": { "BoardType": 0, "BoardCycleActivationMode": 0, "DueDatePolicy": { "TimeMode": 0, "Expectations": [ { "OffsetUnit": 0, "Severity": 0 } ] }, "AttentionSignalPolicy": { "Reasons": [ { "DefaultSeverity": 0 } ], "Audience": [ { "SubjectType": 0 } ] }, "TargetDefinitions": [ { "TargetKind": 0, "RepeatPolicy": 0, "CreateCommentPolicy": 0, "ReadCommentPolicy": 0, "CreateAttachmentPolicy": 0, "ReadAttachmentPolicy": 0 } ], "Statuses": [ { "MetaType": 0 } ], "Transitions": [ { "LinkPrerequisites": [ { "LinkType": 0, "Direction": 0 } ] } ] }, "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}