Skip to main content
POST
Assign Recipients in Bulk

Authorizations

X-Honeycomb-Team
string
header
required

Authenticate using a Honeycomb Configuration Key.

Pass the Token in the X-Honeycomb-Team header:

If you created your key using the API, use data.attributes.secret; this is the same value as the Token in the UI.

To learn how to create a Configuration Key, visit Manage Environment API Keys. To learn more about authenticating requests, visit API Authentication.

Body

application/json

The Signals to update and the Recipients to assign to them.

Select the Signals with selector.signal_ids, using IDs from List All Signals.

  • Problems with the recipients list will reject the whole request before anything is written.
  • One bad Signal ID does not discard the batch.
  • Recipients are added to each Signal's existing set. A Recipient the Signal already has is skipped, and left untouched.
selector
object
required

Chooses which Signals to act on.

recipients
object[]
required

The Recipients to assign to every selected Signal. Each must be referenced by its id from the Recipients API.

Required array length: 1 - 10 elements

Response

The batch was processed. Every requested Signal appears in exactly one of succeeded, unchanged, or failed.

The per-Signal outcome of a bulk Recipient assignment.

succeeded
string[]
required

The Signals whose Recipient set was updated.

Example:
unchanged
string[]
required

The Signals that already had every requested Recipient.

Example:
failed
object[]
required

The Signals that were not updated, each with the reason.