Update a label
/v1/labels/{label_id}const label = await bird.labels.update("lbl_01krdgeqcxet5s7t44vh8rt9mg", {
name: "refund",
color: null,
});
console.log(label.name);label = client.labels.update(
"lbl_01krdgeqcxet5s7t44vh8rt9mg",
name="refund",
color=None,
)
print(label.name)label, err := client.Labels.Update(context.Background(), "lbl_01krdgeqcxet5s7t44vh8rt9mg", bird.LabelsUpdateParams{
Name: bird.Ptr("refund"),
Color: bird.Null[string](),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(label.Name)$label = $bird->labels->update(
'lbl_01krdgeqcxet5s7t44vh8rt9mg',
(new LabelUpdate())->setName('refund')->setColor(null),
);
echo $label->getName();bird labels update <label-id> --name 'Qualified lead'curl -X PATCH "https://us1.platform.bird.com/v1/labels/{label_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Qualified lead"
}'{
"id": "lbl_01krdgeqcxet5s7t44vh8rt9mg",
"name": "Hot lead",
"color": "#E5484D",
"description": "Inbound sales enquiry from a company. Not support requests or vendors.",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
Renames a label, or changes or removes its colour or description. Omitted fields are left unchanged, and the label keeps its ID. The new name must not already be in use in the workspace, regardless of case.
Parameters
label_idstringThe catalogue label to act on.
Request Payload
nameThe label name, unique in the workspace regardless of case. No commas, control characters, or leading or trailing whitespace. System names such as inbox, sent, unread, open or assigned are reserved.
colorThe new colour, or null to remove it.
descriptionThe new description, or null to remove it.
Response Payload
idID of the label, accepted by every operation that takes a label_id. It stays the same when the label is renamed.
nameThe label name, unique in the workspace regardless of case. No commas, control characters, or leading or trailing whitespace. System names such as inbox, sent, unread, open or assigned are reserved.
colorThe label colour as a #RRGGBB hex value, or null when none is set.
descriptionWhen to apply the label, or null when none is set.
created_atupdated_atRelated resources
Continue with the documentation, guides and examples for this topic.