alpha

Update advisor settings (v4)

Change the organization's Advisor settings (id "organization"), which every campaign of every product runs with: each field present sets it (priorities null or empty is none), each field absent keeps its current value. Every save is one revision recording the signed-in member who saved it; the answer is that revision, and a repeated Idempotency-Key answers the revision its first request saved and writes nothing. Changed priorities or listSize make Advisor's next review due at once: it runs at the next hourly dispatch, or when a review already running finishes; a new refresh interval moves Advisor's review onto its periods (each UTC month from the 1st, or each UTC week from Monday). Needs a signed-in member.

post/api/v1/alpha/advisor-settings/update-v4

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/alpha/advisor-settings/update-v4
  • Auth: 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

id'organization' required

"organization", Advisor's one org-wide scope

refreshInterval'weekly' | 'monthly'

When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday

prioritiesstring nullable

What Advisor weighs, and sets aside what conflicts with; null or empty is none

implementationTracking'off' | 'suggest' | 'complete'

Autotracking: off; suggest (Alpha checks the public website and a met check asks a person to confirm the action is done); complete (a met check completes an action whose status no person has set)

listSize3 | 5 | 10 | 15 | 20

How many open actions Advisor keeps on the list: each review places that many, the largest opportunities first, and sets the rest aside, still listed

Response

Success.

id'organization' required

"organization", Advisor's one org-wide scope

refreshInterval'weekly' | 'monthly' required

When Advisor reviews the list: each UTC month from the 1st, or each UTC week from Monday

prioritiesstring nullable required

What Advisor weighs, and sets aside what conflicts with; null is none

implementationTracking'off' | 'suggest' | 'complete' required

Autotracking: off; suggest (Alpha checks the public website and a met check asks a person to confirm the action is done); complete (a met check completes an action whose status no person has set)

listSize3 | 5 | 10 | 15 | 20 required

How many open actions Advisor keeps on the list: each review places that many, the largest opportunities first, and sets the rest aside, still listed

revisioninteger required

The revision's number: each save adds one

savedAtstring date-time required

When it was saved

Changes

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