Mentioned my brand
Parameters, defaults and rules of the "Mentioned my brand" signal template.
Detect when prospects mention your brand on LinkedIn: posts naming your product anywhere on LinkedIn.
| Key | mentioned-my-brand |
| Category | my_network |
| Watches | person |
| Setups | Discovery and account monitoring |
Set this signal up with POST /v3/signal-setups: send the template's id as signal_template_id and the parameters below in parameters. Its id is in List signal templates. Any parameter not listed here is refused with a 422.
Parameters
| Parameter | Type | Required | Allowed values | Default | Description |
|---|---|---|---|---|---|
| scopes | array of string | Yes | discovery, account_monitoring (at least one) | — | Where the signal looks. |
| keywords | array of string | No | At least one keyword | Your workspace domain | The brand spellings to look for. We recommend sending them: the default is only your domain. |
Default is what the server stores when you leave the parameter out. — means there is no default: the parameter is required, or it is simply not set.
Rules
- When you leave
keywordsout, your workspace domain is stored as the only keyword. The setup then shows it inparameters.keywords. - Keywords you send always win over the default.
- The list and get routes leave
defaultout of this property when the workspace has no domain. - The list and get routes show this default for one persona when you pass
persona_idtoGET /v3/signal-templates. In a workspace with several personas, withoutpersona_id, this property carries nodefault. - Sending
keywords: []is refused: send at least one keyword, or leave the property out. - Setting this signal up needs your persona to have at least one job title and one location, otherwise the request is refused with a
422. With several personas, sendpersona_idwhen you create the setup (see Create a signal setup).
Errors
A parameter that is missing, of the wrong type, or not an allowed value is refused with a 422 that names it under errors, for example parameters.scopes. These errors are specific to this signal template:
| Status | Cause |
|---|---|
| 422 | parameters.keywords is left out and your workspace has no domain to use as the default. Add keywords. |
| 422 | parameters.keywords is empty. Send at least one keyword. |
| 409 | The signal template is archived. |
Example
parameters of a setup:
{
"scopes": ["discovery"],
"keywords": ["acme", "acme.com", "Acme Inc"]
}