API v3 is live and in beta: expect possible malfunctions and breaking changes in the coming days. If you find a bug, please report it to your Sillage contact.
APIv3Signal TemplatesParameters by template

Engaged with my content on LinkedIn

Parameters, defaults and rules of the "Engaged with my content on LinkedIn" signal template.

Know when prospects engage with your posts, your company page or the content of your team. It reads the posts of your own company page and of the people on your "All my employees" list. With account monitoring, only engagers from your key accounts are kept.

Keyengaged-with-my-content-on-linkedin
Categorymy_network
Watchesperson
SetupsDiscovery 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

ParameterTypeRequiredAllowed valuesDefaultDescription
scopesarray of stringYesdiscovery, account_monitoring (at least one)—Where the signal looks.
list_idintegerNoThe id of an employee listYour "All my employees" listAn employee list. Defaults to your All my employees list.

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

  • list_id defaults to your "All my employees" list: setup.fields shows its id as the default, it is stored when the setup is created and returned when you read it. Any employee list is accepted, and you can move the setup to another one later. null is refused like for any parameter that has a default. Find its id with List lists (type=employee), and add or remove people with Add members and Remove a member.
  • setup.fields does not show the list_id default: the server applies it when the setup is created.
  • The company page read is always your own: there is no company page parameter, and company_page is refused like any unknown parameter.
  • 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, send persona_id when 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:

StatusCause
422parameters.list_id is not an employee list of the workspace, or the workspace has no "All my employees" list yet (it is created from the workspace domain): "must be the id of an employee list of this workspace. See GET /v3/lists.".
422parameters.list_id is null: "cannot be removed or set to null: send the new value instead, or leave it out to keep the current one".
409The signal template is archived.

Example

parameters of a setup:

{
  "scopes": ["account_monitoring"]
}

Read back with GET, the stored parameters carry the default list:

{
  "scopes": ["account_monitoring"],
  "list_id": 812
}

On this page