Update a specific Post
This endpoint updates a specific post
info
This operation requires authentication. The logged user must be the post creator.
HTTP Request
PUT /api/v2/post/{id}/
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
» text | body | string | false | The content of the post in html format, it can contain some mentions |
» categories | body | list(integer) | true | List of Category ids |
» medias | body | list(integer) | false | List of Media ids |
» location | body | object¦null | false | The Location object to associate at the post |
»» location | body | string¦null | true | Location name |
»» lat | body | number¦null | true | Location latitude |
»» lng | body | number¦null | true | Location longitude |
» poll | body | object¦null | false | The poll object to associate at the post |
»» title | body | string | true | Poll title |
»» multiple_choices | body | boolean | false | If poll choices can be multiple |
»» expiration_at | body | string(date-time) | false | Poll expiration datetime |
»» choices | body | list(object) | true | Poll choices objects |
»»» choice | body | string | true | Poll choice title |
» addressing | body | list(integer) | false | List of Tag ids |
Example Body Parameters
- JSON
{
"text": "string",
"categories": ["integer"],
"medias": ["integer"],
"location": {
"location": "string",
"lat": "integer",
"lng": "integer
},
"poll": {
"title": "string",
"multiple_choices": "boolean",
"closed": "boolean",
"expiration_at": "string",
"choices": [
{
"choice": "string"
}
]
},
"addressing": ["integer"],
"tags": ["integer"]
}
Example Request
- JavaScript
- Bash
const inputBody = '{
"text": "string",
"categories": ["integer"],
"medias": ["integer"],
"location": {
"location": "string",
"lat": "integer",
"lng": "integer
},
"poll": {
"title": "string",
"multiple_choices": "boolean",
"closed": "boolean",
"expiration_at": "string",
"choices": [
{
"choice": "string"
}
]
},
"addressing": ["integer"],
"tags": ["integer"]
}';
const headers = {
'Content-Type':'application/json',
'Accept':'application/json',
'Authorization': 'Bearer {access_token}'
};
fetch('/api/v2/post/{id}/',
{
method: 'PUT',
body: inputBody,
headers: headers
})
.then(function(res) {
return res.json();
}).then(function(body) {
console.log(body);
});
# You can also use wget
curl -X PUT /api/v2/post/{id}/ \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access_token}' \
--data-raw '{
"text": "string",
"categories": ["integer"],
"medias": ["integer"],
"location": {
"location": "string",
"lat": "integer",
"lng": "integer
},
"poll": {
"title": "string",
"multiple_choices": "boolean",
"closed": "boolean",
"expiration_at": "string",
"choices": [
{
"choice": "string"
}
]
},
"addressing": ["integer"],
"tags": ["integer"]
}'
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Response status code | Post |
Example responses
- 200
{
"id": "integer",
"type": "string",
"last_activity_at": "string",
"author": {User},
"added_at": "string",
"last_edited_at": "string",
"html": "string",
"summary": "string",
"deleted": "boolean",
"collapsed": "boolean",
"comment_count": "integer",
"view_count": "integer",
"vote_count": "integer",
"reactions_count": [{Reaction}],
"voted": "boolean",
"reaction": {Reaction},
"follower_count": "integer",
"followed": "boolean",
"suspended": "boolean",
"flag_count": "integer",
"share_count": "integer",
"slug": "string",
"categories": [{Category}],
"medias": [{Media}],
"location": {Locality},
"addressing": ["integer"],
"tags": ["integer"],
"poll": {Poll}
}