Skip to main content
Browse the docs

Stop repeating a visit

DELETE/api/v1/visit_series/{id}

Removes the series and its scheduled visits from effective_from (default now). Earlier visits stay and lose their link.

  • Needs an API key, and runs with the access of the member who made the key.
  • Send an Idempotency-Key. The same key with the same request within 24 hours gives the first answer again and changes nothing.
  • A connected AI assistant can use it too, as deleteVisitSeries.

Parameters

In the address

  • idstring (uuid)required

In the query string

  • effective_fromstring (date)

    First date (in the series' time zone) the change applies to.

Headers

  • Idempotency-Keystringrequired

    Unique user-scoped key for safely retrying this mutation for 24 hours.

    At least 1 character. Up to 200 characters.

Request body

Sent as application/json.

  • lock_versioninteger

    At least 0.

Responses

204The operation completed successfully.

No body.

A refusal answers in the one error shape every operation shares.

Example

A request our own tests send. The ids are made up: put your own in their place.

curl -X DELETE "https://app.tradesender.co.uk/api/v1/visit_series/80614f58-0641-5432-97ed-556ec96e9785" \
  -H "Authorization: Bearer $TRADESENDER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "lock_version": "1"
}'