---
title: "Update a document membership"
method: POST
path: "/userMemberships.update"
tags: ["UserMemberships"]
---

# Update a document membership

`POST /userMemberships.update`

## Request

- Base URL: `https://app.getoutline.com/api`
- URL: `https://app.getoutline.com/api/userMemberships.update`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://app.getoutline.com/oauth/authorize`
    - Token URL: `https://app.getoutline.com/oauth/token` scopes: `read`, `write`

Update the authenticated user's membership of a shared document, used to reorder documents in the sidebar.

## Request body

- object
  - `id` string, uuid, required: Unique identifier for the membership.
  - `index` string, required: The fractional index to move the document to in the sidebar.

## Response `200`

OK

- object
  - `data` Membership
    - `id` string: Unique identifier for the object.
    - `userId` string, uuid: Identifier for the associated user.
    - `documentId` string, uuid, nullable: Identifier for the associated document, if any.
    - `collectionId` string, uuid, nullable: Identifier for the associated collection, if any.
    - `permission` 'read' | 'read_write'
    - `createdById` string, uuid: Identifier for the user who created this membership.
    - `sourceId` string, uuid, nullable: Identifier for the membership this one was inherited from, if any.
    - `index` string, nullable: The position of the collection in the user's sidebar.
  - `policies` Policy[]
    - `id` string, uuid: Unique identifier for the object this policy references.
    - `abilities` object: The abilities that are allowed by this policy, if an array is returned then the individual ID's in the array represent the memberships that grant the ability.

## Other responses

- `400`: The request failed one or more validations.
- `401`: The API key is missing or otherwise invalid.
- `403`: The current API key is not authorized to perform this action.
- `404`: The specified resource was not found.
- `429`: The request was rate limited.

## Changes

- **2026-09-05** `6287bce7caad`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/defaulr/apis/outline-api/changes/userMemberships.update/post.md)

---

[API](https://skmtc.dev/defaulr/apis/outline-api.md) - [All operations](https://skmtc.dev/defaulr/apis/outline-api/llms.txt) - [OpenAPI document](https://skmtc.dev/defaulr/apis/outline-api/revisions/5ddf01ffba84?raw)