---
title: "Get customer edit reviews"
method: GET
path: "/api/v1/business/customer-edit-reviews/{id}"
tags: ["business"]
deprecated: true
---

# Get customer edit reviews

`GET /api/v1/business/customer-edit-reviews/{id}`

## Request

- Base URL: `https://point11.ai`
- URL: `https://point11.ai/api/v1/business/customer-edit-reviews/{id}`
- Auth: one of:
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://auth.point11.ai/oauth2/authorize`, token URL `https://auth.point11.ai/oauth2/token`)

> **Deprecated.**

Deprecated: use business.customer-edit-reviews.get.v2 (business_customer_edit_reviews_get_v2), which reads a review whose conversation holds a message over 8,000 characters. This version gets a bulk edit review a business_customer_edit_reviews_create_v5 run is writing, by its runId: running while any batch is still being written, then succeeded (at least one batch accepted) or failed. Returns each batch's customers and state (pending, accepted, or failed), every accepted batch's customers with their proposed changes, buyer type, fields and labels, and their option sets, and the request the review was started with (its customers in order, conversation, readings, brief and files), which business_customer_edit_reviews_create_v5 takes again, its customerIds narrowed, to review again. A review with a message over 8,000 characters is refused (409 CUSTOMER_EDIT_REVIEW_VERSION_UNSUPPORTED).

## Path parameters

- `id` string, uuid, required: The business_customer_edit_reviews_create_v5 runId

## Headers

- `Point11-Organization` string, uuid

## Response `200`

Success.

- BusinessCustomerEditReviewsGetResponse
  - `runId` string, uuid, required
  - `status` 'running' | 'succeeded' | 'failed', required: running while any batch is pending; succeeded once every batch ended and at least one was accepted; failed when none was
  - `customerCount` integer, required
  - `batches` object[], required
    - `batch` integer, required
    - `state` 'pending' | 'accepted' | 'failed', required
    - `customerIds` string[], required
  - `optionSets` object[], required
  - `customers` object[], required
    - `customerId` string, uuid, required
    - `name` string, nullable, required
    - `version` integer, required
    - `optionSet` integer, nullable, required
    - `changes` object[], required
      - `field` 'gender' | 'age' | 'age.band' | 'language' | 'location' | 'market' | 'areaType' | 'education' | 'lifeStage' | 'household' | 'householdIncome' | 'householdIncome.band' | 'jobTitle' | 'occupation' | 'seniority' | 'employer' | 'yearsInRole' | 'companySize' | 'companySize.band' | 'annualRevenue' | 'audience' | 'product' | 'channel' | 'buyerRole' | 'stakeholders' | 'intentStage' | 'budget' | 'constraints' | 'job' | 'situation' | 'triggerType' | 'trigger' | 'functionalNeed' | 'emotionalNeed' | 'socialNeed' | 'desiredOutcome', required
      - `before` string, nullable, required
      - `after` string, nullable, required
      - `current` union, required
        - object
          - `kind` 'text', required
          - `text` string, nullable, required
        - object
          - `kind` 'option', required
          - `id` string, nullable, required
        - object
          - `kind` 'words', required
          - `words` string, required
        - object
          - `kind` 'place', required
          - `place` object, required
            - `countryCode` string, nullable, required
            - `subdivision` string, nullable, required
            - `locality` string, nullable, required
            - `postalCode` string, nullable, required
        - object
          - `kind` 'household', required
          - `household` object, nullable, required
            - `adults` integer, nullable, required
            - `children` integer, nullable, required
            - `pets` integer, nullable, required
      - `proposed` union, required
        - object
          - `kind` 'text', required
          - `text` string, nullable, required
        - object
          - `kind` 'option', required
          - `id` string, nullable, required
        - object
          - `kind` 'words', required
          - `words` string, required
        - object
          - `kind` 'place', required
          - `place` object, required
            - `countryCode` string, nullable, required
            - `subdivision` string, nullable, required
            - `locality` string, nullable, required
            - `postalCode` string, nullable, required
        - object
          - `kind` 'household', required
          - `household` object, nullable, required
            - `adults` integer, nullable, required
            - `children` integer, nullable, required
            - `pets` integer, nullable, required
      - `follows` 'gender' | 'age' | 'age.band' | 'language' | 'location' | 'market' | 'areaType' | 'education' | 'lifeStage' | 'household' | 'householdIncome' | 'householdIncome.band' | 'jobTitle' | 'occupation' | 'seniority' | 'employer' | 'yearsInRole' | 'companySize' | 'companySize.band' | 'annualRevenue' | 'audience' | 'product' | 'channel' | 'buyerRole' | 'stakeholders' | 'intentStage' | 'budget' | 'constraints' | 'job' | 'situation' | 'triggerType' | 'trigger' | 'functionalNeed' | 'emotionalNeed' | 'socialNeed' | 'desiredOutcome', nullable, required
      - `newValue` boolean, required
      - `fit` 'exact' | 'nearest', nullable, required
      - `said` string, nullable, required
    - `labels` object[], required
      - `name` string, required
      - `said` string, nullable, required
    - `businessProfileId` string, uuid, nullable, required
    - `product` object, nullable, required
      - `before` string, nullable, required
      - `after` string, required
      - `current` string, nullable, required
      - `proposed` union, required
        - object
          - `kind` 'product', required
          - `id` string, required
        - object
          - `kind` 'new_product', required
          - `name` string, required
          - `description` string, required
      - `fit` 'exact' | 'nearest', required
      - `said` string, nullable, required
    - `buyerType` 'consumer' | 'organization', nullable, required
    - `fields` object[], required
      - `field` 'gender' | 'age' | 'age.band' | 'language' | 'location' | 'market' | 'areaType' | 'education' | 'lifeStage' | 'household' | 'householdIncome' | 'householdIncome.band' | 'jobTitle' | 'occupation' | 'seniority' | 'employer' | 'yearsInRole' | 'companySize' | 'companySize.band' | 'annualRevenue' | 'audience' | 'product' | 'channel' | 'buyerRole' | 'stakeholders' | 'intentStage' | 'budget' | 'constraints' | 'job' | 'situation' | 'triggerType' | 'trigger' | 'functionalNeed' | 'emotionalNeed' | 'socialNeed' | 'desiredOutcome', required
      - `value` string, nullable, required
      - `current` union, required
        - object
          - `kind` 'text', required
          - `text` string, nullable, required
        - object
          - `kind` 'option', required
          - `id` string, nullable, required
        - object
          - `kind` 'words', required
          - `words` string, required
        - object
          - `kind` 'place', required
          - `place` object, required
            - `countryCode` string, nullable, required
            - `subdivision` string, nullable, required
            - `locality` string, nullable, required
            - `postalCode` string, nullable, required
        - object
          - `kind` 'household', required
          - `household` object, nullable, required
            - `adults` integer, nullable, required
            - `children` integer, nullable, required
            - `pets` integer, nullable, required
  - `request` object, required: The business_customer_edit_reviews_create_v5 input this review was started with: its customers in the order selected, the conversation, its readings, the brief and the files. Send it again, its customerIds narrowed to those to review again
    - `customerIds` string[], required: The selected customers' ids, any number, each once
    - `messages` object[], required
      - `role` 'member' | 'assistant', required
      - `text` string, required
    - `readings` object[], required
      - `field` 'gender' | 'age' | 'language' | 'location' | 'market' | 'areaType' | 'education' | 'lifeStage' | 'household' | 'householdIncome' | 'jobTitle' | 'occupation' | 'seniority' | 'employer' | 'yearsInRole' | 'companySize' | 'annualRevenue' | 'audience' | 'product' | 'channel' | 'buyerRole' | 'stakeholders' | 'intentStage' | 'budget' | 'constraints' | 'job' | 'situation' | 'triggerType' | 'trigger' | 'functionalNeed' | 'emotionalNeed' | 'socialNeed' | 'desiredOutcome' | 'labels', required
      - `summary` string, required
    - `attachmentIds` string[]
    - `brief` string: The decided reading of the conversation, in plain words, which the review applies as decided: which customers change and how, the shares across the whole selection, what follows from a change, and how each open choice was settled with the member. Readings still name the fields to change, and messages hold the member's own words

## Other responses

- `400`: The input, query, or Idempotency-Key is invalid.
- `401`: The bearer is missing, expired, or not accepted.
- `403`: The credential lacks the operation's scope or role, or the operation needs a different door.
- `404`: The resource or organization does not exist for this caller.
- `405`: This path takes another HTTP method, named in `Allow`.
- `409`: The request conflicts with current state or with prior use of its Idempotency-Key.
- `413`: The request, or the answer it asks for, is too large; narrow it.
- `429`: The credential's rate budget is spent; retry after `Retry-After` seconds.
- `500`: An unexpected server failure; retry later. Only `request_id` identifies it.
- `503`: A dependency is temporarily unavailable; retry after `Retry-After` seconds.
- `default`: Another status a product answers for its own refusal (for example `415` for an unsupported attachment); branch on `code`.

---

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