Create a company/deal attribute | Brevo API Documentation

Create a new custom attribute for companies or deals. The attribute label must be unique within the object type, cannot exceed 50 characters, and cannot use reserved names. For single-select or multi-choice attribute types, you must also provide the optionsLabels array.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Attribute creation data for a company/deal.

attributeTypeenumRequired

The type of attribute (must be one of the defined enums)

labelstringRequired

The label for the attribute (max 50 characters, cannot be empty)

objectTypeenumRequired

The type of object the attribute belongs to. Must be either companies or deals.

Allowed values:

descriptionstringOptional

A description of the attribute

optionsLabelslist of stringsOptional

Options for multi-choice or single-select attributes

Response

Created new attribute

idstring

Unique ID of the created attribute

Errors

400

Bad Request Error

1	import { BrevoClient } from "@getbrevo/brevo";
2
3	async function main() {
4	const client = new BrevoClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.companies.createACompanyDealAttribute({
8	attributeType: "single-select",
9	label: "Attribute Label",
10	objectType: "companies",
11	});
12	}
13	main();