Editar | Credonix

Descripción general

Este endpoint actualiza parcialmente un grupo de mensajes. Todos los campos del cuerpo son opcionales y siguen las mismas reglas que en Crear grupo de mensajes. Una solicitud exitosa devuelve 200 con el grupo actualizado y el grupo conserva su estado active.

La solicitud funciona de dos formas:

Solo name: cambia únicamente el nombre, que se guarda tal cual. Los mensajes no cambian.
Cualquier otro cuerpo (incluye include_all_customers, customer_ids, excluded_customer_ids o messages, o es un objeto vacío {}): los campos que omites conservan su valor actual y el grupo completo se valida de nuevo. Si envías messages, reemplaza todos los mensajes del grupo. Los mensajes se vuelven a guardar, así que su id cambia aunque su contenido sea el mismo.

Requiere el permiso Crear en Grupos de mensajes. Cambiar solo el nombre requiere el permiso Administrar en Grupos de mensajes.

Endpoint

PATCHhttps://app.credonix.mx/api/v1/message-groups/{groupId}

Path param: groupId — el id del grupo de mensajes.

Cambia el nombre

Envía solo name. Los mensajes conservan su id. Requiere el permiso Administrar en Grupos de mensajes.

{ "name": "Cobranza preventiva mensual" }

curl -X PATCH "https://app.credonix.mx/api/v1/message-groups/cmu2191cf003mv1dqbwjy3iks" \-H "Authorization: Bearer TU_API_KEY" \-H "Content-Type: application/json" \-d '{ "name": "Cobranza preventiva mensual" }'

Cambia los clientes o los mensajes

Envía los campos de contenido que quieras cambiar. Como messages no se envía, el grupo conserva sus mensajes, pero se vuelven a guardar con un id nuevo.

{ "include_all_customers": false }

curl -X PATCH "https://app.credonix.mx/api/v1/message-groups/cmu2191cf003mv1dqbwjy3iks" \-H "Authorization: Bearer TU_API_KEY" \-H "Content-Type: application/json" \-d '{ "include_all_customers": false }'

Cambiar el nombre sin permiso de administrar

Si la API key tiene el permiso Crear pero no Administrar en Grupos de mensajes, cambiar solo el nombre responde 403 con el código INSUFFICIENT_PERMISSIONS.

curl -X PATCH "https://app.credonix.mx/api/v1/message-groups/cmu2191cf003mv1dqbwjy3iks" \-H "Authorization: Bearer TU_API_KEY" \-H "Content-Type: application/json" \-d '{ "name": "Cobranza preventiva mensual" }'

Reglas de los campos

Campo	Tipo	Requerido	Notas
`name`	string	No	Mínimo 1 carácter. Si es el único campo, se guarda sin recortar espacios. Si se valida el contenido del grupo, se recortan los espacios y admite máximo 50 caracteres.
`include_all_customers`	boolean	No	Si se omite, conserva su valor actual.
`customer_ids`	string[]	No	Reemplaza los clientes incluidos. Si se omite, conserva su valor actual.
`excluded_customer_ids`	string[]	No	Reemplaza los clientes excluidos. Si se omite, conserva su valor actual.
`messages`	array	No	Reemplaza todos los mensajes del grupo. Cada mensaje sigue las reglas de los mensajes.

Errores

Status	Código	Causa
`400`	`VALIDATION_ERROR`	Un campo tiene un valor o tipo incorrecto, o el cuerpo incluye campos desconocidos.
`400`	`INVALID_MESSAGE_GROUP`	El nombre o un mensaje no cumple las reglas del grupo.
`400`	`CUSTOMER_NOT_FOUND`	Un `id` de `customer_ids` o `excluded_customer_ids` no corresponde a un cliente de tu organización.
`401`	`MISSING_API_KEY`, `INVALID_API_KEY`, `API_KEY_REVOKED`	API key ausente, inválida o revocada.
`403`	`INSUFFICIENT_PERMISSIONS`	La API key no tiene el permiso Crear en Grupos de mensajes, o se envió solo `name` sin el permiso Administrar.
`404`	`NOT_FOUND`	El grupo no existe en esta organización. Si solo se envió `name`, la respuesta incluye `"Group not found"`; en los demás casos, `"El grupo no existe o no tienes acceso a él."`.
`500`	`INTERNAL_ERROR`	Solo se envió `name` y tiene más de 50 caracteres.

Crear grupo de mensajes POST

Página anterior

Eliminar grupo de mensajes DELETE

Página siguiente