Delete Post API

Delete existing post of user

Path Parameters

post_id number required

post id

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string required

user access token

client string required

client access token

expiry string required
timestamp of token expiry
Example: 1531163311
token-type string required
access token type
Example: Bearer
uid string required
user uid
Example: user@quranreflect.com

Responses

• 200
• 401

---

OK

Response Headers

application/json

Schema

Example (from schema)

Example 1

Example

---

Schema

success boolean

Default value: true

message string

Default value: Post was successfully removed.

{
  "success": true,
  "message": "Post was successfully removed."
}

{
  "success": true,
  "message": "Post was successfully removed."
}

{
  "success": true,
  "message": "Post was successfully removed."
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

Loading...