RestrictionAction

Una restriction action registra que un titular entró a una lista de exclusión (restrict) o salió de ella (lift). Cada acción aplicada crea una nueva versión del agreement del titular, con su propia evidencia.

idstringrequired

Identificador público de la acción.

Example: restact_1B2M2Y8AsgTpgAmY7PhCfg

kindstringrequired

restrict agrega al titular a la lista; lift lo saca de ella.

Possible values: [restrict, lift]

Example: restrict

statusstringrequired

Estado de la acción. no_changes indica que no había nada que levantar, porque las restricciones ya estaban levantadas.

Possible values: [pending, applied, no_changes, failed]

Example: applied

subject_idstringnullablerequired

ID del titular. Es null si el titular se eliminó después de registrar la acción.

Example: ent_1B2M2Y8AsgTpgAmY7PhCfg

subject_typestringrequired

Example: Entity

restriction_template_idstringrequired

ID de la plantilla de restricción.

Example: restpl_wAspvmEr4ACDZaPUtfwjsA

restriction_template_versionintegerrequired

Versión de la plantilla con la que se registró la acción.

Example: 1

effective_atdate-timerequired

Desde cuándo rige la acción.

Example: 2026-09-29T13:00:00.000Z

expires_atdate-timenullable

Hasta cuándo rige la restricción. null indica que no vence.

reason_codestringnullable

Código corto del motivo, definido por tu empresa (por ejemplo sernac o unsubscribe). Es texto libre: Soyio no valida sus valores. Queda en la evidencia sellada y se copia a cada restricción, así que no incluyas datos personales.

Example: sernac

reason_textstringnullable

Explicación del motivo en texto libre. Queda guardada en la acción, pero no forma parte de la evidencia ni de las restricciones del agreement.

channelstringnullable

Canal por el que el titular hizo la solicitud.

Possible values: [digital, phone_call, in_person]

Example: phone_call

originstringnullable

Desde dónde se registró la solicitud, por ejemplo call center. No incluyas datos personales del titular: este campo queda dentro de la evidencia sellada y no se puede borrar después.

Example: call center

metadata object

Datos propios de tu integración, hasta 4 KB. No incluyas datos personales del titular: este campo queda dentro de la evidencia sellada y no se puede borrar después.

property name*any

Datos propios de tu integración, hasta 4 KB. No incluyas datos personales del titular: este campo queda dentro de la evidencia sellada y no se puede borrar después.

origin_event objectrequired

Identifica el evento de tu sistema que originó la acción, para que puedas cruzarla con tus propios registros. Reenviar el mismo system y event_id no crea una segunda acción. No incluyas datos personales del titular: este campo queda dentro de la evidencia sellada y no se puede borrar después.

systemstringrequired

Sistema que registró la solicitud.

Example: call_center

event_idstringrequired

Identificador del evento en ese sistema.

Example: CL-9931

occurred_atdate-timenullable

Cuándo ocurrió el evento en tu sistema.

Example: 2026-09-29T12:58:00Z

agreement_idstringnullable

ID del agreement que produjo la acción. Es nulo si la acción no cambió el agreement.

Example: agr_1B2M2Y8AsgTpgAmY7PhCfg

agreement_versionintegernullable

Example: 4

created_atdate-timerequired

Example: 2026-09-29T13:00:00.000Z

RestrictionAction
{
  "id": "restact_1B2M2Y8AsgTpgAmY7PhCfg",
  "kind": "restrict",
  "status": "applied",
  "subject_id": "ent_1B2M2Y8AsgTpgAmY7PhCfg",
  "subject_type": "Entity",
  "restriction_template_id": "restpl_wAspvmEr4ACDZaPUtfwjsA",
  "restriction_template_version": 1,
  "effective_at": "2026-09-29T13:00:00.000Z",
  "expires_at": "2024-07-29T15:51:28.071Z",
  "reason_code": "sernac",
  "reason_text": "string",
  "channel": "phone_call",
  "origin": "call center",
  "metadata": {},
  "origin_event": {
    "system": "call_center",
    "event_id": "CL-9931",
    "occurred_at": "2026-09-29T12:58:00Z"
  },
  "agreement_id": "agr_1B2M2Y8AsgTpgAmY7PhCfg",
  "agreement_version": 4,
  "created_at": "2026-09-29T13:00:00.000Z"
}