alpha

Get customer cases

Get a customer case the signed-in member opened (alpha_customer_cases_create): its conversation, kind, a describe case's business profile (null for a customer edit), how many customers a customer edit's selection holds or a describe case describes (count), every review its most recent reviewing turn requested (latestReviewRunIds, in request order, each a run business_customer_edit_reviews_get_v2 follows, and that turn, latestReviewTurnId; empty and null before the first), and the newest description its turns requested (latestDescriptionId, which business_customer_descriptions_get reads; null before the first). Needs a signed-in member.

get/api/v1/alpha/customer-cases/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/customer-cases/{id}
  • Auth: OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Path parameters

idstring uuid required

The case's caseId

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

caseIdstring uuid required
conversationIdstring uuid required

The case's Alpha conversation

kind'customer_edit' | 'customer_describe' | 'crm_import' required
businessProfileIdstring uuid nullable required

The business profile a describe case adds customers to, or a CRM import's upload adds to; null for a customer edit, whose selection may span profiles

customerCountinteger required

How many customers a customer edit's selection holds now (a deleted customer leaves it); 0 for any other kind

countinteger nullable required

How many rows the case's grid makes: the new customers a describe case describes, or the rows a CRM import's file holds; null for a customer edit

namestring nullable required

A CRM import's name, its upload's; null on any other kind

latestReviewRunIdsstring[] required

Every review the case's most recent reviewing turn requested (one per group of the selection it changes differently), in request order, each the run business_customer_edit_reviews_get_v2 follows; empty before the first

latestReviewTurnIdstring uuid nullable required

The turn those reviews belong to, as a review's live part names it; null before the first review

latestDescriptionIdstring uuid nullable required

The newest description a describe case's turns requested, which business_customer_descriptions_get reads; null before the first

latestMappingVersionIdstring uuid nullable required

The mapping version a CRM import follows now (its Lead's latest, or the member's own from the grid), which business_crm_mapping_versions_get reads and the upload imports under; null on any other kind

createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.