contacts

Create contact attribute

Create a new contact attribute under the specified category and name. The required body properties depend on the category: use "type" for normal, transactional, or category attributes; use "value" for calculated or global attributes; use "enumeration" for category attributes; and use "multiCategoryOptions" for normal multiple-choice attributes. None of the category or multicategory option values can exceed 200 characters.

post/contacts/attributes/{attributeCategory}/{attributeName}

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/attributes/{attributeCategory}/{attributeName}
  • Auth: API key in header api-key

Path parameters

attributeCategory'normal' | 'transactional' | 'category' | 'calculated' | 'global' required

Category of the attribute

attributeNamestring required

Name of the attribute

Request body

isRecurringboolean

Type of the attribute. Use only if the attribute's category is 'calculated' or 'global'

multiCategoryOptionsstring[]

List of options you want to add for multiple-choice attribute. Use only if the attribute's category is "normal" and attribute's type is "multiple-choice". None of the multicategory options can exceed max 200 characters. For example: ["USA","INDIA"]

type'text' | 'date' | 'float' | 'boolean' | 'id' | 'category' | 'multiple-choice' | 'user'

Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' Type user and multiple-choice is only available if the category is normal attribute Type id is only available if the category is transactional attribute Type category is only available if the category is category attribute

valuestring

Value of the attribute. Use only if the attribute's category is 'calculated' or 'global'

Response

Attribute created

ContactsCreateAttributeResponse201 required

Empty response body

Changes

No recorded changes to this operation across all 1 revision of this API.