> ## Documentation Index > Fetch the complete documentation index at: https://docs.niadra.com/llms.txt > Use this file to discover all available pages before exploring further. # Criar uma retenção legal > Mantém os dados de um handle, de um objeto ou de uma conversa fora do expurgo até a liberação. Funcionalidade `legal_holds`. ## OpenAPI ````yaml openapi/pt/cell.json POST /v1/legal-holds openapi: 3.1.0 info: title: API de dados da Niadra version: '1' description: >- Escrita, contexto, histórico, objetos, identidade, privacidade e governança de um espaço. Cada espaço tem um endereço estável, com o espaço e a região no nome. servers: - url: https://{space}.{region}.api.niadra.com variables: space: default: acme-prod description: O espaço, que vem na chave de fonte. region: default: us-east-2 description: A região do espaço, que também vem na chave. security: [] paths: /v1/legal-holds: post: tags: - signals summary: Criar uma retenção legal description: >- Mantém os dados de um handle, de um objeto ou de uma conversa fora do expurgo até a liberação. **Autenticação.** Token de pessoa do Console com o papel `security` (ou admin), ou chave de fonte com o escopo `admin`. Só responde num espaço com a funcionalidade `legal_holds` ligada (o documento `features`); num espaço sem ela, 404. operationId: create_legal_hold_v1_legal_holds_post parameters: - in: header name: Idempotency-Key required: true schema: maxLength: 256 minLength: 1 title: Idempotency-Key type: string description: >- Obrigatório. Guardado por 24 horas com o hash do corpo: a mesma chave com o mesmo corpo devolve a primeira resposta, e a mesma chave com outro corpo devolve 409 `conflict`. requestBody: content: application/json: schema: $ref: '#/components/schemas/LegalHoldCreate' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/LegalHold' description: A retenção. '422': content: application/problem+json: schema: $ref: '#/components/schemas/Problem' description: O pedido não bate com o contrato. security: - sourceKey: [] - personToken: [] components: schemas: LegalHoldCreate: additionalProperties: false description: >- Exatamente um de `handle`, `object` ou `conversation_id`: o que fica fora do expurgo enquanto a retenção está ativa. properties: conversation_id: anyOf: - maxLength: 512 minLength: 1 type: string - type: 'null' title: Conversation Id handle: anyOf: - $ref: '#/components/schemas/Handle' - type: 'null' object: anyOf: - $ref: '#/components/schemas/ObjectRef' - type: 'null' reason: maxLength: 500 minLength: 1 title: Reason type: string required: - reason title: LegalHoldCreate type: object LegalHold: additionalProperties: false properties: created_at: format: date-time title: Created At type: string hold_id: maxLength: 512 minLength: 1 title: Hold Id type: string released_at: anyOf: - format: date-time type: string - type: 'null' title: Released At scope: enum: - handle - object - conversation title: Scope type: string status: enum: - active - released title: Status type: string required: - hold_id - scope - status - created_at title: LegalHold type: object Problem: additionalProperties: false description: >- Detalhes do problema no formato da RFC 9457; `code` vem do catálogo de erros versionado. properties: code: title: Code type: string detail: anyOf: - type: string - type: 'null' default: null title: Detail request_id: anyOf: - type: string - type: 'null' default: null title: Request Id status: title: Status type: integer title: title: Title type: string type: default: about:blank title: Type type: string required: - title - status - code title: Problem type: object Handle: additionalProperties: false description: >- Um identificador de um sujeito num canal ou sistema: um telefone, um e-mail, um id do CRM. properties: scope: anyOf: - maxLength: 256 minLength: 1 type: string - type: 'null' description: >- Espaço de nomes dos identificadores com escopo: a conta do WhatsApp Business para `wa_bsuid`, o sistema para `system_id`, o país para `gov_id_hmac`. title: Scope subject_kind: anyOf: - $ref: '#/components/schemas/SubjectKind' - type: 'null' description: >- O padrão é `person`, exceto nos tipos de handle que só identificam organizações. type: $ref: '#/components/schemas/HandleType' value: maxLength: 320 minLength: 1 title: Value type: string description: >- O identificador. Normalizado no servidor: E.164 para telefone, minúsculas para e-mail. required: - type - value title: Handle type: object ObjectRef: additionalProperties: false description: Um objeto de negócio num sistema de registro. properties: id: maxLength: 512 minLength: 1 title: Id type: string description: O id nesse sistema. namespace: maxLength: 256 minLength: 1 title: Namespace type: string description: O sistema onde ele vive, como `erp`. type: maxLength: 256 minLength: 1 title: Type type: string description: Tipo do objeto, como `invoice`, `order` ou `ticket`. required: - type - namespace - id title: ObjectRef type: object SubjectKind: enum: - person - account - partner title: SubjectKind type: string description: >- Uma pessoa, uma organização cliente (`account`) ou uma organização que participa sem ser cliente (`partner`). HandleType: enum: - phone_e164 - wa_id - wa_jid - wa_lid - wa_bsuid - email - gov_id_hmac - app_user_id - system_id - org_registry_hmac - email_domain - anon_id title: HandleType type: string description: >- O tipo de identificador. O valor é classificado pelo formato, nunca pelo campo de onde veio. securitySchemes: sourceKey: type: http scheme: bearer description: nia_sk_... personToken: type: http scheme: bearer bearerFormat: JWT ````