Crear o actualizar marcas

Envía un arreglo de marcas. Cada ítem crea la marca cuando su id no existe, o la actualiza cuando ya existe. Envía solo los campos a cambiar. El id va en cada ítem y no se puede renombrar aquí.

Requiere un access token con el scope brands:write. Ver Token para obtenerlo.

Un ítem con solo id refresca updated_at si la marca ya existe. Un id nuevo requiere name. Si omites status queda ACTIVE. Si omites cms_template_id queda sin plantilla.

Solicitud

curl -X PUT "https://firespark.cloud/api/integrations/v1/brands" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    { "id": "0001", "name": "Burger Co", "status": "ACTIVE" },
    { "id": "0002", "name": "Pizza Co" }
  ]'

Cuerpo

Un arreglo de 1 a 100 ítems. Cada ítem acepta estos campos:

Campo	Tipo	Descripción
`id`	string	Id externo de la marca. Obligatorio. Caracteres alfanuméricos, `_` y `-`, de 1 a 64 caracteres.
`name`	string	Nombre visible, 1–100 caracteres. Letras, números y espacios simples. Obligatorio al crear.
`cms_template_id`	string (UUID)	Plantilla CMS a vincular. `null` la quita.
`status`	string	`ACTIVE` o `INACTIVE`.

Si se envían labels, cms, uid, merchant_id o env, se ignoran.

Respuesta

Zod valida el cuerpo completo antes de guardar. Si algún campo es inválido, responde HTTP 400 y no se guarda ningún ítem. Cuando el cuerpo es válido, los ítems se guardan uno tras otro. El HTTP es 200 solo si todos se guardaron. Si un ítem posterior falla por una regla de negocio, el HTTP es el status de ese ítem (422 o 500).

Campo	Descripción
`id`	El `id` del ítem. `null` si faltaba o no era válido.
`status`	`200` si se guardó. `422` si `name` ya lo usa otra marca, o si un `id` nuevo llegó sin `name`. `500` por un fallo inesperado.
`data`	La marca guardada, con `labels` y `cms`. Solo cuando `status` es `200`.
`error`	Mensaje de error. Solo cuando `status` no es `200`.
`details`	Detalle del error a nivel de ítem.

{
  "data": [
    {
      "id": "0001",
      "status": 200,
      "data": {
        "id": "0001",
        "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "merchant_id": "c1d2e3f4-a5b6-7890-cdef-123456789abc",
        "name": "Burger Co",
        "status": "ACTIVE",
        "cms_template_id": null,
        "cms": null,
        "labels": []
      }
    },
    {
      "id": "0002",
      "status": 422,
      "error": "Brand name already exists",
      "details": null
    }
  ]
}

{
  "error": "Invalid fields",
  "details": {
    "0.name": "Only letters and numbers are allowed"
  }
}

Errores

Estado	Descripción
`400`	El cuerpo no es un arreglo de 1 a 100 ítems, o algún ítem tiene campos inválidos. No se guarda ningún ítem.
`401`	Access token ausente o inválido.
`403`	El token no incluye el scope `brands:write`.

Documentación de API

Endpoints

Guías

Recursos

Crear o actualizar marcas

Solicitud

Cuerpo

Respuesta

Errores

​Solicitud

​Cuerpo

​Respuesta

​Errores

Solicitud

Cuerpo

Respuesta

Errores