action trashnothing_submit_post {
label: "Submit a post"
description: "Submits a new post.\n"
provider: trashnothing
method: POST
path: "/posts"
encoding: json
output: {
type: "object"
properties: {
identifier: {
type: "string"
description: "When an error or warning is returned, this will contain a short string representing the type of error or warning that occurred. Is null on success.\n"
}
message: {
type: "string"
description: "Contains text describing the reason a post was not successful. Is null on success.\n"
}
preference_key: {
type: "string"
description: "Certain types of warnings can be opted out of. These warnings will set preference_key to a string that can be set in the preferences object by the client to opt out of that type of warning in the future (see the description of the preferences parameter for more details). Is null for errors, success and warnings that can't be opted out of.\n"
}
result: {
type: "string"
description: "One of: success, error, warning.
A success result indicates that the post was submitted successfully. Note that posts may not appear instantly after submission because the volunteer moderators of many groups may have additional automatic or manual review processes in place that can cause delays.
An error result indicates that there is an error with the post that should be shown to the user and the message property will contain text describing the error.
A warning result indicates that there is a warning about the post to show the user and the message property will contain a string describing the warning. A warning result doesn't prevent a post from being submitted, to continue the submission process after a warning result, just re-submit (with the updated session object) to temporarily override that specific warning.\n"
}
session: {
type: "object"
description: "The updated session object that should override the client's copy of the session that was passed in the session parameter. Is null on success.\n"
}
}
}
}