Skip to content

Keyword.create

Saves a term you target, with its locale and the page that should rank for it.

Action class
None
Approval
Runs on its own
Emits
Keyword.created
Price
Free
POST https://api.sb/{your-domain}/keywords

It extends the hub’s record call Keyword.create, which every Keyword takes. It is one of the Verbs of SEO.

Inputs

NameTypeMeaning
phrasestringRequired. The words searched or asked.
formstringOne of search or question. Optional.

The hub inherits this call on every Noun: it takes the Keyword’s own Properties, listed on the hub’s Keyword page.

Outputs

FieldTypeWhat null means
keywordKeywordNever null: the Keyword as the call leaves it.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Keyword.created fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

The Keyword is saved as the call leaves it, with the Action that changed it.

Emits

Keyword.created with { keyword }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Keyword.created delivers the result.

You, to your agent
Target “rent ledger template” with the template page.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Keyword.create",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by

None.