Skip to content

by Startups.Studio

Growth Customer

Customer.delete

DELETE /{namespace}/customers/{id}

Deletes a Customer; its history is kept.

Noun: Customer
Mode: do
Event: Customer.deleted

You, to your agent

Remove the latest customer.

curl -X DELETE https://api.sb/ledgerlark.com/customers/customer_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const customer = await $.Customer.delete({ id: 'customer_1' })

npx startup-builder do Customer.delete --json '{"id":"customer_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Customer.delete({ id: 'customer_1' })"
  }
}

Delete removes a Customer; its history is kept. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Customer.

Outputs

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

Effects

Emits Customer.deleted.
One-way: send, do.

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.delete

When it waits

Gate	Default
Decision class	Medium: one-way, bounded
Delay window	1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
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.create

Previous Page

Customer.exempt

Next Page