---
title: "questionnaire_locked"
method: POST
path: "questionnaire_locked"
tags: ["Webhooks"]
---

# questionnaire_locked

`POST questionnaire_locked` (webhook)

A questionnaire was locked. Always delivered as JSON, regardless of the firm's webhook encoding preference.

## Payload

- object
  - `id` integer
  - `questionnaire_name` string, nullable
  - `tax_year` integer, nullable
  - `external_entity_id` string, nullable
  - `entity_id` integer
  - `entity_tags` EntityTag[]: Tags as objects.
    - `id` integer
    - `name` string
  - `client_email` string, nullable
  - `client_name` string, nullable
  - `entity_name` string, nullable
  - `entity_type` string, nullable
  - `client_phone` string, nullable
  - `client_timezone` string, nullable
  - `firm_role_summary` string: A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use `GET /entities/{entity_id}/firm_role_assignments` if you need the underlying ids.
  - `link` string, uri, nullable
  - `advisors` object[]
    - `name` string, nullable
    - `email` string, nullable

## Acknowledgement `200`

Return any 2xx to acknowledge. Returning `410 Gone` deletes the subscription.

---

[API](https://skmtc.dev/soraban/apis/soraban-private-api.md) - [All operations](https://skmtc.dev/soraban/apis/soraban-private-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soraban/apis/soraban-private-api/revisions/1c230fa547ad?raw)