---
title: "Read back rule"
method: POST
path: "/v1/rules/read-back"
tags: ["Owner"]
---

# Read back rule

`POST /v1/rules/read-back`

## Request

- Base URL: `https://api.vicem.ai`
- URL: `https://api.vicem.ai/v1/rules/read-back`
- Auth: HTTP bearer

## Request body

- ReadBackRuleRequest
  - `rule` union, required
    - object
      - `kind` 'away', required
      - `until` string, date-time, required
      - `callerLine` string, nullable
    - object
      - `kind` 'expecting', required
      - `who` string, required
      - `number` string
      - `contactId` string
      - `until` string, date-time, required
    - object
      - `kind` 'always_put_through', required
      - `contactId` string
      - `saysFrom` string, nullable
      - `until` string, date-time
    - object
      - `kind` 'caller_note', required
      - `for` union, required
        - 'everyone'
        - string
        - Id[]
      - `text` string, required
      - `until` string, date-time
    - object
      - `kind` 'say_no', required
      - `topic` string, required
      - `politeLine` string, required
    - object
      - `kind` 'handling_note', required
      - `text` string, required
      - `until` string, date-time
    - object
      - `kind` 'booking_day', required
      - `day` integer, required
      - `allowed` false, required
    - object
      - `kind` 'job_hunt', required
      - `until` string, date-time, required
      - `roles` string[]
    - object
      - `kind` 'job_hunt_end', required
    - object
      - `kind` 'unsupported', required
      - `reason` string, required
      - `link` string, required

## Response `200`

OK

- ProposeRuleResponse
  - `rule` union, required
    - object
      - `kind` 'away', required
      - `until` string, date-time, required
      - `callerLine` string, nullable, required
    - object
      - `kind` 'expecting', required
      - `who` string, required
      - `number` string, required
      - `contactId` string, required
      - `until` string, date-time, required
    - object
      - `kind` 'always_put_through', required
      - `contactId` string, required
      - `saysFrom` string, nullable, required
      - `until` string, date-time, required
    - object
      - `kind` 'caller_note', required
      - `for` union, required
        - 'everyone'
        - string
        - Id[]
      - `text` string, required
      - `until` string, date-time, required
    - object
      - `kind` 'say_no', required
      - `topic` string, required
      - `politeLine` string, required
    - object
      - `kind` 'handling_note', required
      - `text` string, required
      - `until` string, date-time, required
    - object
      - `kind` 'booking_day', required
      - `day` integer, required
      - `allowed` false, required
    - object
      - `kind` 'job_hunt', required
      - `until` string, date-time, required
      - `roles` string[], required
    - object
      - `kind` 'job_hunt_end', required
    - object
      - `kind` 'unsupported', required
      - `reason` string, required
      - `link` string, required
  - `readBack` object, required
    - `who` union, required
      - object
        - `kind` 'everyone', required
      - object
        - `kind` 'person', required
        - `name` string, required
        - `contactId` string, required
    - `until` string, date-time, required
    - `says` string, nullable, required
    - `does` string, required
    - `line` object
      - `key` 'away' | 'expecting' | 'putThrough' | 'saysFrom' | 'note' | 'sayNo' | 'jobHunt' | 'jobHuntEnd' | 'jobHuntRow' | 'tells' | 'expectingRow' | 'own' | 'bookingDay' | 'awayRow' | 'cantDo' | 'caseNotRule' | 'nameWhoHears', required
      - `arg` string, nullable
      - `day` integer
      - `addFreeTimes` boolean
    - `canSave` boolean, required
    - `link` object, nullable, required
      - `label` string
      - `path` string, required
    - `endable` boolean, required
    - `owner` string, nullable
    - `bookingDay` object
      - `day` integer, required
      - `next` integer[], required
    - `stillReach` string[]
  - `hash` string, required

## Other responses

- `400`: Invalid request (body not JSON, or schema validation failed).
- `401`: Missing, expired or invalid bearer token.
- `413`: Body over the limit (64 KB; 512 KB for contact import).
- `500`: Unexpected server error (reported to Sentry).

---

[API](https://skmtc.dev/vicem/apis/vicem-api.md) · [All operations](https://skmtc.dev/vicem/apis/vicem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vicem/apis/vicem-api/revisions/9efcec07e5f4?raw)