Skip to content
firmus.shdocs

Every page's text, headings and title. Code samples are not indexed.

Stop following a segment

Stop delivering a saved segment's entering and leaving companies to one list; the segment stays saved.

Answers 204 No Content with no body: from then on nothing more about that segment is delivered to the list. The segment stays saved, and other lists that follow it keep doing so. Once no list of the organization follows it, its unit of the watched-segments allowance is freed at once.

A list that does not follow the segment, and a list or segment that is not your organization's, are 404 not_found, so a second DELETE is a 404, not a 204. Treat that 404 as done when you retry. Following the segment again later takes a new baseline: what entered it in between is not delivered.

Deleting the saved segment or the watchlist stops the follow as well. Not counted as a call.

DELETE/v1/{country_code}/watchlists/{watchlist_id}/segments/{segment_id}Scope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr
segment_idpathintegerYes1
watchlist_idpathintegerYes1

Request

bash
curl -X DELETE -H "Authorization: Bearer $FIRMUS_KEY" \
  "https://api.firmus.sh/v1/fr/watchlists/1/segments/1"

Responses

Nothing more is delivered for this segment to this list. The segment stays saved.