Lead routes: update, delete

Reference for Lead, one group of Lead routes.

Lead.update

Changes the given properties of a Lead. Verb page.

Text

PATCH /{namespace}/leads/{id}

Path: id. Body, as JSON: the other inputs. Emits Lead.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Lead.
`email`	`email`		The primary email address.
`phone`	`string`		The primary phone number.
`name`	`string`		The name the Contact goes by.
`interest`	`text`		What the Lead asked for.
`owner`	Worker		The Worker who answers it.

Returns

Output	Type	Required	Description
`lead`	Lead	required	The Lead.

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

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"owner":"worker_whZFpOKWIV"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "lead": {
    "$id": "https://api.sb/leaseline.app/leads/lead_Kz1R9fhqzZ",
    "$type": "Lead",
    "status": "new",
    "owner": "worker_whZFpOKWIV"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Lead.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Lead.delete

Deletes a Lead: a soft delete that keeps its history, undone by Thing.restore. Verb page.