Skip to content

Delete Search Term

Deletes a search term — the Delete row action on the admin Marketing → Search & SEO → Search Terms screen.

TIP

New here? Read the Search Terms overview for what a search term records and how its fields behave.

Operation

OperationTypePurpose
deleteAdminMarketingSearchTermMutationDelete a search term

Details

  • Requires an admin Bearer token and the marketing.search_seo.search_terms.delete permission.
  • Pass the term's IRI as id. Use the list query to discover valid ids.

Confirm success via the absence of errors

The delete mutation returns a success acknowledgement, not the deleted term's data — adminMarketingSearchTerm resolves to null on the payload. Treat a response with no errors[] as a successful delete. If you need a confirmation message in the body, use the REST endpoint (DELETE /api/admin/marketing/search-terms/{id}), which returns { "message": "Search term deleted." }.

Input fields

FieldTypeRequiredNotes
idIDYesThe term's IRI

Released under the MIT License.