business

Get customer descriptions

Get one customer description business_customer_descriptions_create_v3 read, by its descriptionId: the answer it gave, its outcome, review, unresolved phrases, the Manual Profile card (version 3) to pass to business_manual_profiles_create_v2 (its employerAccounts as rows to business_customers_generate), dropped facts and products, unchanged. A description saved in a retired format is refused (describe again).

get/api/v1/business/customer-descriptions/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/customer-descriptions/{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)

Path parameters

idstring uuid required

The business_customer_descriptions_create_v3 descriptionId

Headers

Point11-Organizationstring uuid

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

Response

Success.

descriptionIdstring uuid required
outcome'interpreted' | 'no_customers_described' | 'language_unsupported' required
droppedstring[] required

Changes

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