Establecer mapeos de campos custom

POST/users/v1/custom-fields/mappings

Este servicio reemplaza todos los mapeos de campos personalizados de un usuario por el contenido del request body.

Comportamiento

El request body contiene la lista completa de mapeos deseados. Después de una llamada exitosa, enviaremos los mapeos del cliente en el campo mappings. Si no incluyes un slot en el request, lo eliminaremos de la tabla de mapeos. Los valores personalizados ya almacenados para esos slots se mantienen, pero no tendrán key ni display_name asociados hasta que configures un nuevo mapeo.

Restricciones

slot: número entero de 1 a 10. Debe ser único dentro del request. Un slot duplicado devuelve un error de validación.
key: Requerido. Máximo 64 caracteres. Debe estar en formato snake_case (comenzar con una letra minúscula, seguida de letras minúsculas, dígitos y guiones bajos). Debe ser único por cliente y único dentro del mismo request.
display_name: Opcional. Máximo 64 caracteres. Caracteres permitidos: letras (incluyendo acentos), dígitos, espacios y los símbolos -_.,().
Máximo 10 mapeos por cliente.

Ejemplo

{
  "mappings": [
    { "slot": 1, "key": "employee_id", "display_name": "Employee ID" },
    { "slot": 2, "key": "department", "display_name": "Department" }
  ]
}

Después de esta llamada, el usuario tendrá 2 mapeos configurados (slots 1 y 2). Los mapeos anteriores en otros slots serán eliminados.

Parámetros disponibles

Header Parameters

AuthorizationStringrequired

Cuerpo de solicitud

application/json

mappingsarrayrequired3 propiedades

Detalle de respuestas

401

No autorizado

403

Acceso denegado

Ejemplo de solicitud

{
  "mappings": [
    {
      "slot": 1,
      "key": "employee_id",
      "display_name": "Employee ID"
    }
  ]
}

Ejemplo de código

curl -X POST "https://api.pomelo.la/users/v1/custom-fields/mappings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "mappings": [
    {
      "slot": 1,
      "key": "employee_id",
      "display_name": "Employee ID"
    }
  ]
}'

Ejemplo de respuesta (200)Mapeos actualizados

{
  "data": [
    {
      "slot": 1,
      "key": "employee_id",
      "display_name": "Employee ID"
    }
  ]
}

Listar mapeos de campos custom

Crear Sesión