Metadatas

Register custom metadata to enrich your campaign with information that describes, contextualizes or locates your sends.

How to Access

Access: Marketing / Settings / Metadatas, as shown in the Figure 1:

Figure 1: Path to Metadatas.


Main Screen

Figure 2: Main Screen - Metadatas.

The main screen displays a table with all metadatas registered in the system.

New Button

Located in the upper left corner, the button allows creating a new metadata.


Table Information

The metadata table contains the following columns:

Column
Description

Key

Unique identifier of the metadata (e.g.: CAMPAIGN, DEPARTMENT, LINK)

Type

Data type accepted by the metadata (TEXT, FILE, EMAIL, CPF_CNPJ, PHONE)

Key Change

Visual indicator (✓ or ✗) if changing the key after creation is allowed

Active

Visual indicator (✓ or ✗) if the metadata is active in the system

Predefined values

Visual indicator (✓ or ✗) if it has a list of pre-established values

Action

Buttons to edit (pencil icon) or delete (trash icon) the metadata


Create Metadata

Figure 3: Metadata Creation Screen.

By clicking the system opens the creation screen.

Available Fields

Key:

  • Required text field

  • Defines the unique identifier of the metadata

  • Will be used as a technical reference in the system

  • Example: CAMPAIGN, PROTOCOL, LINK

Metadata Types:

  • Required selection field

  • Defines the data type that the metadata structures

  • Available options:

    • TEXT: Free text field

    • FILE: Allows file uploads

    • EMAIL: Field validated for email addresses

    • CPF_CNPJ: Field validated for CPF or CNPJ

    • PHONE: Field validated for phone numbers

    • ALL DEPARTMENTS OF ATDO DIGITAL: List with all departments in the system

    • MY DEPARTMENTS OF ATDO DIGITAL: List with the user's departments

Allow key change:

  • Switch (on/off)

  • When enabled, allows changing the key identifier after creation

  • Useful for future adjustments without needing to recreate the metadata

Allow predefined values:

  • Switch (on/off)

  • When enabled, allows creating a list of pre-established values

  • Useful to standardize data and prevent input errors

How to Create

  1. Click the New

  2. Fill in the field Key with the technical identifier

  3. Select the Metadata Type desired

  4. (Optional) Enable Allow key change

  5. (Optional) Enable Allow predefined values

  6. Click Confirm to save

  7. Or click Cancel to close without saving


Edit Metadata

Figure 4: Edit Metadata.

By clicking in the column Action, the system opens the editing screen.

Editable Fields

Key:

  • Displays the current name of the metadata

  • Can be edited if the option Allow key change is enabled

Type:

  • Displays the currently selected type

  • May have an icon X to clear and select a new type

Allow key change:

  • Toggle that can be enabled/disabled

  • Controls whether the key can be changed in the future

Active:

  • Toggle that controls whether the metadata is active in the system

  • When disabled, it deactivates the metadata for use

Allow predefined values:

  • Toggle that can be enabled/disabled

  • Controls whether there will be a list of pre-established values

How to Edit

  1. Click on the row of the desired metadata

  2. Adjust the necessary fields

  3. Enable or disable the toggles as needed

  4. Click to save the changes

  5. Or click to discard changes

  6. Or click to return to the list


Delete Metadata

Figure 5: Delete Metadata.

In the column Action, each metadata has an icon . Clicking it, the system requests confirmation for deletion.

Important: Delete metadatas only if you are sure they are not being used in active campaigns.


Detailed Metadata Types

TEXT

Characteristics:

  • Free text field

  • Space provided by underline

When to use:

  • Context information. Example: name of the person who triggered the campaign.

FILE

Characteristics:

  • Allows uploading documents

When to use:

  • Contracts

  • Receipts

  • Scanned documents

EMAIL

Characteristics:

When to use:

  • Customer email

  • Secondary contact email

  • Responsible person's email

CPF_CNPJ

Characteristics:

  • Field validated for CPF or CNPJ

  • Accepts formatting with or without dots and dashes

When to use:

  • Triggers that require identification of people

PHONE

Characteristics:

  • Field validated for phone numbers

  • Accepts different formats

When to use:

  • Alternative phone

  • Business phone

  • Secondary contact phone

ALL DEPARTMENTS OF ATDO DIGITAL

Characteristics:

  • Dropdown list with all registered departments

  • Single selection

When to use:

  • To direct the person who interacted with the template to the correct department flow

MY DEPARTMENTS OF ATDO DIGITAL

Characteristics:

  • Dropdown list only with departments of the user who triggered the template

When to use:

  • To direct the person who interacted with the template to the correct department flow

Last updated