Actualizar Agente

PUThttps://{environment}.metrocuadrado.com/rest-api/agents/{agentId}

Actualiza la información de un agente inmobiliario existente.

Ambientes Disponibles

Ambiente	URL Base
Desarrollo	https://ptec-core-dev.metrocuadrado.com/rest-api/agents/{agentId}
Producción	https://www.metrocuadrado.com/rest-api/agents/{agentId}

Parámetros

Headers

Header	Valor	Requerido	Descripción
Content-Type	application/json	Sí	Tipo de contenido
x-api-key	string	Sí	API key de autenticación
token	string	Sí	Token JWT de acceso

Body

URL Parameter:

• agentId (en la URL): ID del agente a actualizar

Body Fields:

Campo	Tipo	Requerido	Descripción	Ejemplo
integratorId	number	Sí	ID del integrador	2
principalContact	string	No	Contacto principal	"S"
state	string	Sí	Estado del agente	"A"
companyId	number	Sí	ID de la empresa	5219
city	string	Sí	Ciudad	"3"
document	string	Sí	Documento de identidad	"555888999"
email	string	Sí	Correo electrónico	"cesar.agente@m2.com.co"
name	string	Sí	Nombre	"Ingrid Marcela"
lastName	string	Sí	Apellido	"Rodriguez"
phone	number	No	Teléfono fijo	3320032
mobilePhone	number	No	Teléfono móvil	5679087650
branchOffice	number	No	Sucursal	54150
updateComment	string	No	Comentario de actualización	"Lorem ipsum"
personContactPhoneList	array	No	Lista de teléfonos de contacto	Ver ejemplo
personContactMobileList	array	No	Lista de móviles de contacto	Ver ejemplo
responseUrl	string	Sí	URL de respuesta	"https://example.com/callback"

Ejemplo completo del body:

{
  "integratorId": 9999,
  "name": "Laura",
  "lastname": "García",
  "email": "ejemplo@correo.com",
  "cityId": 5,
  "state": "A",
  "updateComment": "Activación de agente de soporte",
  "personContactMobileList": [
    {
      "state": "A",
      "value": "3209876543",
      "contactWithWathsapp": "S"
    }
  ],
  "responseUrl": "https://ejemplo.com/"
}

Ejemplos

Request

curl -X PUT \
  'https://ptec-core-dev.metrocuadrado.com/rest-api/agents/12345' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: TU_API_KEY' \
  -H 'token: tu-jwt-token' \
  -d '{
    "integratorId": 9999,
    "name": "Laura",
    "lastname": "García",
    "email": "ejemplo@correo.com",
    "cityId": 5,
    "state": "A",
    "updateComment": "Activación de agente de soporte",
    "personContactMobileList": [
      {
        "state": "A",
        "value": "3209876543",
        "contactWithWathsapp": "S"
      }
    ],
    "responseUrl": "https://ejemplo.com/"
  }'

200 OK

{
  "data": {
    "transactionId": "2a0f2cd3-e6ad-4980-8f2a-bbc9047c8629",
    "response": "Transacción de actualizacion recibida"
  }
}

404 Not Found

{
  "error": "Agente no encontrado"
}

401 Unauthorized

{
  "error": "Token de autorización inválido o expirado"
}

Códigos de Respuesta

Código	Descripción
200	Agente actualizado correctamente
401	Token inválido o expirado
404	Agente no encontrado

Notas Importantes

- Requiere un token JWT válido (generar en el endpoint de autenticación)

- La API Key debe corresponder al ambiente seleccionado

- Todos los campos marcados como requeridos deben enviarse

• El campo agentId debe existir en el sistema
• Los campos del body deben cumplir con el formato esperado

Cómo Probar

Para probar este endpoint, sigue estos pasos:

1. Genera un token JWT usando el endpoint de autenticación
2. Asegúrate de usar la API Key correcta según el ambiente
3. Incluye el token en el header token
4. Prepara el body JSON con los datos actualizados del agente
5. Incluye el ID del agente en la URL
6. Realiza la petición PUT al endpoint correspondiente

Probar Endpoint

API Tester

Prueba los endpoints de forma interactiva

Token Requerido

Este endpoint requiere autenticación. Configura un token JWT válido usando el botón de token en la parte superior de la página.

Ambiente: DesarrolloProducción

ID:

Request Body (JSON):

{}