Label keys

Labels classify envelopes with key and value pairs, such as department: sales or project: alpha, so they are quick to find and filter. You define the keys for the whole organization, and whoever works on each envelope sets the values. Day-to-day use of labels is in Labels.

Who: organization admins and platform admins. Where: Labels, in the sidebar.

Create a key

1. Press New Key. Create Label Key opens.

2. Enter the Name, up to 50 characters. The name is saved in lowercase.

3. Pick a Color from the palette or with the picker. It is the color the label shows in the envelope list.

4. Optionally, enter a Description of up to 200 characters to guide users on which values to use.

5. Press Create. You see “Label key created”.

The page header shows how many keys the organization has and the maximum allowed. Once the maximum is reached, the New Key button is hidden until you delete one.

Edit a key

Press the pencil icon in the row. You can change the name, the color and the description, and confirm with Save. Envelopes that already use the key show the new name and color, with the same values.

Delete a key

Press the bin icon in the row and confirm with Delete in the Delete Label Key dialog. The key is removed from every envelope.

Values are deleted with the key

When you delete a key, the value every envelope held under that key is deleted permanently. If you only want to stop using it, edit its name or description to say so.

Who sets the values

The Contributors and Managers of the envelope’s workspace set values from the envelope detail with + Add label; admins do so on any envelope. Each value holds up to 200 characters. Viewers and Auditors see labels, and anyone with access to the envelope list can filter it by label.

API credentials read the keys and set values according to their role, like a person. Managing the keys is for admins.

Error messages

Message	What happened and what to do
“Failed to create label key”	A key with that name already exists or the maximum was reached. Use another name or delete a key you do not use.
“Failed to update label key”	The new name already exists or is empty. Choose another name.
“Failed to delete label key”	A temporary problem occurred. Wait a moment and try again.