Saltar al contenido principal

POST | /:id/segments

Función que Realiza

Asocia un segmento a un objetivo con un tipo, valor y unidad específicos.


Funcionamiento

  • URL Completa: {domain}/api/v1/targets/:id/segments
  • Acción: POST
  • Requiere Api-Key?: Si
  • Requiere una Sesión?: Si
  • Recibe datos mediante: Params & Body
    • Cantidad de datos: 5
  • Responde con contenido?: No
  • Responde únicamente con código de estado?: Si
    • Código: 201 | Created
  • Códigos de error: Vea la sección Errores

Contenido que se recibe por Parámetros

id = String (targetId)

Contenido que se recibe por Body

Estructura del JSON: {"parámetro": "tipo de dato"}

{
"segmentId": "String (max 36)",
"type": "Enum('VOLUMEN', 'COBERTURA')",
"value": Int,
"unit": "Enum('ucs', 'cajs', '%')"
}

Códigos de Error

HTTP CodeCustom CodeMessage
422INVALID_REQUEST_DATALos datos enviados son inválidos o insuficientes.
422SEGMENT_NOT_FOUNDNo se encontró un segmento con esa id
422TARGET_NOT_FOUNDNo se encontró un objetivo con esa id
422SEGMENT_ALREADY_EXISTSYa existe un segmento con esa ID asignado a este objetivo.
401INVALID_API_KEYLa API Key proporcionada no es válida.
401INVALID_SESSIONLa sesión no es válida o ha expirado.
401INSUFFICIENT_PERMISSIONSNo tienes los permisos suficientes para acceder.