Delete

Description

Delete a story recipient for a story. The recipient will no longer receive story monitoring communications and will be removed from the recipients list.

Request

HTTP Method: DELETE

Parameter Description
story_id The ID of the story in which the story recipient should be deleted.
address The email or webhook URL that should no longer receive story monitoring communications.
draft_id Optional The ID of the draft to update. About drafts.

Sample request

curl -X DELETE \
  https://<<META.tenant.domain>>/api/v1/stories/<<story_id>>/recipients \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "address": "alice@example.com"
      }'

Response

A successful request will return an empty response with a 204 status code.

Was this helpful?