Lead Attributes

Returns up to 25 custom lead attributes of your workspace, or your own attributes when you aren't in a workspace. There's no pagination. Use an attribute's identifier as the key when you set its value in a lead's attributes.

Also accepts an OAuth 2.0 access token with the leads scope.

Creates a custom lead attribute. Its identifier, the key for its values in a lead's attributes, is the name as a lowercase slug: Deal size becomes deal-size.

The request fails with 422 when you already have an attribute with the same identifier, or already have 29 attributes, the limit on every plan.

Also accepts an OAuth 2.0 access token with the leads scope.

Confirms that an attribute exists in your workspace. Only id is filled in: the other fields come back as empty strings, 0, and zero timestamps. To read an attribute's name, identifier, and type, use GET /attributes.

Also accepts an OAuth 2.0 access token with the leads scope.

Renames an attribute and sets its type. Send both fields.

• The identifier is rebuilt from the new name. Values already set on leads stay attached and appear under the new identifier.
• A name whose identifier matches the attribute's current one fails with 422, so you can't change only the type.
• Only attributes you created are changed. For a teammate's attribute, the request returns 200 without changing anything.

Also accepts an OAuth 2.0 access token with the leads scope.

Deletes an attribute of your workspace. Its values no longer appear on leads.

Also accepts an OAuth 2.0 access token with the leads scope.