Skip to main content
PATCH
/
v2
/
access
/
vault
/
lists
/
:listId
Update vault list
curl --request PATCH \
  --url https://api.ofauth.com/v2/access/vault/lists/:listId \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>' \
  --data '
{
  "name": "<string>",
  "clearMedia": false
}
'
{
  "id": 123,
  "name": "<string>",
  "hasMedia": true,
  "canUpdate": true,
  "canDelete": true,
  "medias": [
    {
      "url": "<string>"
    }
  ]
}

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

​
x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Path Parameters

​
listId
number | null

Body

application/json
​
name
string
required

New name for the vault list

Required string length: 1 - 100
​
clearMedia
boolean | null
default:false

Remove all media from the list

Response

Successful response

​
id
number
required
​
type
enum<string>
required
Available options:
custom,
messages,
posts,
stories,
streams,
media_stickers
​
name
string
required
​
hasMedia
boolean
required
​
canUpdate
boolean
required
​
canDelete
boolean
required
​
medias
object[]
required