business

Create customer descriptions (v3)

Describe the customers you want in plain text for one business profile (a member or an API key with business:write); Point11 reads it against the profile's customer mix (trigger types among it) and returns the review to confirm and, when it could interpret it, the Manual Profile card (version 3) to pass unchanged to business_manual_profiles_create_v2 (when it names employerAccounts, give those customers as rows to business_customers_generate, source rows, instead): its mixes, its customers' employers, and the group's given facts by the customer model's keys (a statement about the group, Location country and region codes, the household, a number such as annualRevenue, its labels). dropped names facts the card leaves out because its audiences' buyer type lacks them. A product the profile lacks may be named: products holds the Product mix with each new name, and the card omits its revenue mix until each is created with business_revenue_lines_create_v2 and set on the card by id. Anything it leaves unnamed comes from the Profile.

post/api/v1/business/customer-descriptions/create-v3

Request

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

Headers

Point11-Organizationstring uuid

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

Idempotency-Keystring uuid required

UUID naming this intent. Retry with the same key; reuse for other input is 409.

Request body

businessProfileIdstring uuid required
descriptionstring required
profileNamestring required

The name the resulting Manual Profile takes

contentLanguage'en' | 'fr' | 'es' | 'de' | 'pt' | 'ja' | 'it' | 'nl' | 'sv' | 'cs' | 'pl' | 'tr' | 'ru' | 'zh-Hans' | 'ko' | 'ar' required

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.