Skip to content

by Startups.Studio

Growth Customer

Customer.activate

POST /{namespace}/customers/{customer}/activate

Activate marks a Customer activated on an Offer once its declared activation Event reaches the count within the window.

Noun: Customer
Mode: do
Event: Customer.activated

You, to your agent

Activate the latest customer with an offer.

curl -X POST https://api.sb/patentpad.com/customers/customer_1/activate \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offer":"offer_1"}'

import { $ } from 'startup-builder'

const customer = await $.Customer.activate({ customer: 'customer_1', offer: 'offer_1' })

npx startup-builder do Customer.activate --json '{"customer":"customer_1","offer":"offer_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.activate({ customer: 'customer_1', offer: 'offer_1' })"
  }
}

Inputs

Input	Type	Required	Description
`customer`	Customer	required	The Customer who crossed the line.
`offer`	Offer	required	The Offer whose `activation` was met.

Outputs

Output	Type	Required	Description
`customer`	Customer	required	The activated Customer.

Effects

Emits Customer.activated.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
Runs once per Customer per Offer, from Product analytics, never by hand.
Activation rate, the onboarding checklist and the silence Watch read the Event.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Customer.activate

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Customer

Previous Page

Customer.create

Next Page