Delete agent label

deleteAgentLabel(input: DeleteProjectAgentLabelInput!): AgentDeletionResult!

Requires project.agents.write; API keys also need delete scope.

Arguments

ArgumentTypeRequired
inputDeleteProjectAgentLabelInput!Yes

Input fields

input

DeleteProjectAgentLabelInput

FieldTypeRequiredDescription
projectReferenceStringNo
agentIdID!Yes
sourceTargetKindStringNoSource target: project, main_branch, or preview_branch. Null and omission select project.
targetBranchIdIDNo
labelIdID!Yes

Response

Returns AgentDeletionResult!. Open the type for its fields and nested types.

FieldTypeDescription
okBoolean!Always true: the deletion completed. A failed deletion is a GraphQL error.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation DeleteAgentLabel($input: DeleteProjectAgentLabelInput!) {
  deleteAgentLabel(input: $input) {
    ok
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "agentId": "00000000-0000-4000-8000-000000000001",
    "labelId": "00000000-0000-4000-8000-000000000001"
  }
}