Saltar al contenido

Create a block

Módulo Identity

POST/blocksblocks.create

A person's block of another person or an organization (Section 4.5.6 Profile Privacy). It hides the blocker's profile from the blocked person and from every member of a blocked organization, and the blocked profile from the blocker. Memberships and engagements are not affected. Creates a block. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad me.account.write.
  • Alcances de OAuth: me.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: BlockCreate

blocks.create: BlockCreate
CampoTipoObligatorioDescripción
blocked_urnstringSíURN of the blocked person (urn:xpms:person:{id}) or organization (urn:xpms:organization:{id}).Restricciones: length 1 to 300
{
  "blocked_urn": "urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: Block

blocks.create: Block
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the block.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
blocked_urnstringSíURN of the blocked person (urn:xpms:person:{id}) or organization (urn:xpms:organization:{id}).Restricciones: length 1 to 300
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "blocked_urn": "urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/blocks" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"blocked_urn":"urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.blocks.create({
    "blocked_urn": "urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.blocks.create({"blocked_urn": "urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos blocks create --data '{"blocked_urn":"urn:xpms:person:0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'