Update Post by ID

patch

https://{hostname}/api/talk/content/v1/posts/{id}

This operation updates a user post by ID. User posts have the property type set to user-post. The request can take the full post object as input, but other than postDetails.text all other fields are optional and read-only.

Authorization and Permissions

An OpenAm token is required to update a post.
The user must have content updation permission which is set by the Talk administrator.

Path Params

string

required

The ID of the post to update.

Body Params

The Update Post by ID request payload.

postId

string

The unique ID of a post.

type

string

The type of a post. Only user-post can be updated.

createdBy

string

The user or entity that created a post.

groupDetails

object

The group to which a post is sent. Note: You can only create such posts from the Talk UI at this time.

postDetails

object

The detailed post model.

createdDateTime

date-time

The date and time a post was created.

updatedDateTime

date-time

The date and time a post was last modified.

postSettings

object

The settings model which contains preference for the post. default will be a blank object.

userInteractions

object

The user interactions object, which contains details about the number of likes and comments a post has received.

Headers

Authorization

string

required

An openAM token for the user.

x-correlation-id

string

A UUID value to track the request, used for debugging and tracing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200Successfully submitted a patch request.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

404The HTTP status code 404 Not Found error, the post is not found to be updated.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.