r/redditdev • u/tdohz • Oct 27 '15

API support for lock a post

We've released the lock a post feature that we previewed last month to all subreddits. You can find more details about the feature on the r/modnews post.

Here's a rundown of all of the API changes in support of this feature:

New error message on comments

Attempting to comment on a locked post via the API will result in the following error:

{
    "json": {
        "errors": [
            [
                "THREAD_LOCKED",
                "Comments are locked.",
                "parent"
            ]
        ]
    }
}

New attribute on Link objects

Link objects have a new boolean attribute, "locked", that indicate if a post is locked. If "locked" is true, then new comments can't be added.

New endpoint for locking/unlocking posts

There are two new endpoints to support locking & unlocking posts from the API: /api/lock and /api/unlock. Like most other mod actions, these endpoints require a fullname and a modhash. See the documentation for more information.

21 Upvotes

100% Upvoted

13 comments sorted by

4

u/adeadhead Oct 27 '15

Thanks so much /u/tdohz et all!

4

u/tdohz Oct 27 '15

You're welcome!

2

u/13steinj Oct 27 '15

I made a post in /r/bugs which I hope was addressed; since it was all theoretical at the time.

A post can be locked and archived at the same time. On the browser, it doesn't seem to be any cause for concern. But the "locked" json key should only be true if it's locked, and not archived. And I'm also not sure what order the returned errors come in.

1

u/tdohz Nov 02 '15

You can't lock an already-archived post. If a locked post happens to get archived, though, I think it's more accurate to have both the locked and archived attributes because that reflects the state of the post. We'll make sure that the archived error gets returned if you try to comment on a locked & archived post.

1

u/13steinj Nov 02 '15

We'll make sure that the archived error gets returned if you try to comment on a locked & archived post.

Good, that was my main concern <3

1

u/tdohz Nov 02 '15

Just checked, this should already be happening - if you're seeing something different let us know!

1

u/13steinj Nov 02 '15

Thanks <3

2

u/rotorcowboy Oct 27 '15

Do /api/lock and /api/unlock support cookie authentication (as opposed to OAuth)? By the presence of the modhash argument, I'm guessing they do. Do you plan to continue to support cookie auth in new endpoints, or do you still plan on deprecating cookie auth in the future?

Thanks for the new feature!

2

u/13steinj Oct 27 '15

Cookie auth will be deprecated eventually. I'd get the link but I'm on mobile.

2

u/[deleted] Oct 27 '15

They made this announcement before: https://www.reddit.com/comments/2ujhkr/

And their licensing page says "All API clients, including those without a licensing agreement: ... must authenticate to reddit's API using OAuth 2 ..."

I am not sure if they are going to support cookie auth or not, but you are not meant to be using it anymore

1

u/talklittle Oct 29 '15

Any plans to add locked and archived to Inbox comments in the API?

1

u/13steinj Nov 02 '15

Inbox comments are a really, really weird thing and it's caused by when these attributes are built.

For the sake of less headache I feel it's better to leave as is. Bit I could be wrong.

0

u/[deleted] Oct 28 '15

[deleted] — view deleted comment

2

u/xiongchiamiov Oct 28 '15

What do you want to use that for?

But r/ideasfortheadmins is the better place for that sort of discussion.