Delete a story

Delete a story

DELETE /api/v4/stories/{storyId}

Delete a story

cURL

curl --request DELETE \
  --url https://apix.us.amity.co/api/v4/stories/{storyId} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

storyId · string · required

Pattern: ^[a-f\d]{24}$

Query Parameters

permanent · boolean · default: false

If true, the story will be deleted permanently (hard deleted). If false, the story will be soft deleted.

Response

200

application/json

Delete Result

success · boolean