Skip to main content

Overview

The Publicistas (Advertisers/Publicists) API manages advertiser accounts who work with multiple companies to create and manage advertising campaigns. Publicists act as intermediaries between companies and the advertising platform.

Base Endpoint

POST   /Database/Database/publicistas/
GET    /Database/Database/publicistas/
GET    /Database/Database/publicistas/{id_publicista}/
PUT    /Database/Database/publicistas/{id_publicista}/
PATCH  /Database/Database/publicistas/{id_publicista}/
DELETE /Database/Database/publicistas/{id_publicista}/

The Publicista Object

id_publicista
integer
required
Unique identifier for the advertiser (auto-generated)
id_usuario
integer
required
Foreign key reference to the Usuario (User) account associated with this publicist
ruc
string
required
Tax identification number (RUC) for the publicist’s business. Maximum 13 characters
nombre
string
required
Publicist’s name or business name. Maximum 30 characters
mail_contacto
string
required
Contact email address. Maximum 40 characters
telefono
string
required
Contact phone number. Maximum 10 characters
fecha_creacion
date
required
Date when the publicist account was created (YYYY-MM-DD format)
fecha_modificacion
date
required
Date when the publicist account was last modified (YYYY-MM-DD format)
id_ciudad
integer
required
Foreign key reference to the Ciudad (City) where the publicist operates. Defaults to 1
id_pais
integer
required
Foreign key reference to the Pais (Country) where the publicist operates. Defaults to 1
estado
integer
required
Status of the publicist account. Common values:
  • 0: Inactive
  • 1: Active
  • 3: Disabled

Create a Publicist

curl -X POST https://api.example.com/Database/Database/Database/publicistas/ \
  -H "Content-Type: application/json" \
  -d '{
    "id_usuario": 8,
    "ruc": "1234567890002",
    "nombre": "MediaPro Advertising",
    "mail_contacto": "[email protected]",
    "telefono": "0991234888",
    "fecha_creacion": "2024-01-20",
    "fecha_modificacion": "2024-01-20",
    "id_ciudad": 1,
    "id_pais": 1,
    "estado": 1
  }'
{
  "id_publicista": 5,
  "id_usuario": 8,
  "ruc": "1234567890002",
  "nombre": "MediaPro Advertising",
  "mail_contacto": "[email protected]",
  "telefono": "0991234888",
  "fecha_creacion": "2024-01-20",
  "fecha_modificacion": "2024-01-20",
  "id_ciudad": 1,
  "id_pais": 1,
  "estado": 1
}

Retrieve a Publicist

curl -X GET https://api.example.com/Database/Database/Database/publicistas/5/
{
  "id_publicista": 5,
  "id_usuario": 8,
  "ruc": "1234567890002",
  "nombre": "MediaPro Advertising",
  "mail_contacto": "[email protected]",
  "telefono": "0991234888",
  "fecha_creacion": "2024-01-20",
  "fecha_modificacion": "2024-01-20",
  "id_ciudad": 1,
  "id_pais": 1,
  "estado": 1
}

List All Publicists

curl -X GET https://api.example.com/Database/Database/Database/publicistas/
[
  {
    "id_publicista": 5,
    "id_usuario": 8,
    "ruc": "1234567890002",
    "nombre": "MediaPro Advertising",
    "mail_contacto": "[email protected]",
    "telefono": "0991234888",
    "fecha_creacion": "2024-01-20",
    "fecha_modificacion": "2024-01-20",
    "id_ciudad": 1,
    "id_pais": 1,
    "estado": 1
  },
  {
    "id_publicista": 6,
    "id_usuario": 9,
    "ruc": "5555666677778",
    "nombre": "Creative Campaigns Ltd",
    "mail_contacto": "[email protected]",
    "telefono": "0987654321",
    "fecha_creacion": "2024-02-15",
    "fecha_modificacion": "2024-02-15",
    "id_ciudad": 2,
    "id_pais": 1,
    "estado": 1
  }
]

Update a Publicist

curl -X PUT https://api.example.com/Database/Database/Database/publicistas/5/ \
  -H "Content-Type: application/json" \
  -d '{
    "id_usuario": 8,
    "ruc": "1234567890002",
    "nombre": "MediaPro Advertising Agency",
    "mail_contacto": "[email protected]",
    "telefono": "0991234888",
    "fecha_creacion": "2024-01-20",
    "fecha_modificacion": "2024-03-09",
    "id_ciudad": 1,
    "id_pais": 1,
    "estado": 1
  }'
{
  "id_publicista": 5,
  "id_usuario": 8,
  "ruc": "1234567890002",
  "nombre": "MediaPro Advertising Agency",
  "mail_contacto": "[email protected]",
  "telefono": "0991234888",
  "fecha_creacion": "2024-01-20",
  "fecha_modificacion": "2024-03-09",
  "id_ciudad": 1,
  "id_pais": 1,
  "estado": 1
}

Delete a Publicist

curl -X DELETE https://api.example.com/Database/Database/Database/publicistas/5/
HTTP 204 No Content

Filter Publicists by Status

You can filter publicists by their status:
curl -X GET "https://api.example.com/Database/Database/Database/publicistas/?estado=1"
[
  {
    "id_publicista": 5,
    "id_usuario": 8,
    "ruc": "1234567890002",
    "nombre": "MediaPro Advertising Agency",
    "mail_contacto": "[email protected]",
    "telefono": "0991234888",
    "fecha_creacion": "2024-01-20",
    "fecha_modificacion": "2024-03-09",
    "id_ciudad": 1,
    "id_pais": 1,
    "estado": 1
  }
]

Filter Publicists by Location

curl -X GET "https://api.example.com/Database/Database/Database/publicistas/?id_ciudad=1&id_pais=1"

User Roles and Permissions

Publicists are typically associated with user accounts that have role ID 2. They have permissions to:
  • Manage multiple company accounts through EmpresaXPublicista relationships
  • Create and manage campaigns for associated companies
  • View sectors and campaigns for their associated companies

Build docs developers (and LLMs) love