Contacts

Create contact attribute

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

Request

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

Path parameters

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

Category of the attribute

attributeNamestring required

Name of the attribute

Request body

valuestring

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

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". For example: ["USA","INDIA"]

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

Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' ( type 'boolean' 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 )

Example request

{
  "value": "COUNT[BLACKLISTED,BLACKLISTED,<,NOW()]",
  "isRecurring": true,
  "enumeration": [
    {
      "value": 1,
      "label": "Women"
    }
  ],
  "type": "text"
}

Response

Attribute created

Changes

No recorded changes to this operation across all 2 revisions of this API.