Brand

Update alternative names

Changed on

Add, remove or replace the project's alternative names: other names the brand goes by (a former, local or shortened name), which count as the brand in every report. This is the app's Knowledge Base → Profile → Alternative names. Send add and/or remove, or replace on its own to set the whole list. Answers already collected follow the change. An added name's mentions under Other companies move to the brand. A removed name's brand mentions move to a competitor of that name, which is created if the project has none. Both moves run in the background, and a paused project queues neither. A name is matched ignoring case. Adding a name the project already has changes nothing and lists it in alreadyPresent. Removing a name it lacks returns 404 not_found and changes nothing. A project holds up to 25 names, each up to 120 characters. Adding needs the Member role; removing needs Owner, Super admin or Admin, since it creates competitors. Requires the knowledge:manage capability. A pitch project that is not currently active refuses with 409 INACTIVE_PITCH_PROMPT_MUTATION. The list reads back as profile.alternativeNames on the brand profile.

patch/api/mcp/projects/{projectId}/brand-profile/alternative-names

Request

  • Base URL
    https://app.searchable.com
  • Auth
    HTTP bearer

Path parameters

projectIdstring uuid required

The project id.

Request body

addstring[]

Names to add. A name the project already has is left as it is.

removestring[]

Names to remove, matched ignoring case. Each must be one of the project's alternative names.

replacestring[]

The whole list the project should have; names not in it are removed. An empty list removes every name. Not combined with add or remove.

Response

Alternative names updated.

successboolean required
alternativeNamesstring[] required

The project's alternative names after the change.

addedstring[] required

Names this request added.

removedstring[] required

Names this request removed, as they were saved.

alreadyPresentstring[] required

Names asked for that the project already had; nothing changed for them.

Changes