VRChatBackendDocs/Apis/PropsApi.md

PropsApi

All URIs are relative to https://api.vrchat.cloud/api/1

Method	HTTP request	Description
createProp	POST /props	Create Prop
deleteProp	DELETE /props/{propId}	Delete Prop
getProp	GET /props/{propId}	Get Prop
getPropPublishStatus	GET /props/{propId}/publish	Get Prop Publish Status
listProps	GET /props	List Props
publishProp	PUT /props/{propId}/publish	Publish Prop
unpublishProp	DELETE /props/{propId}/publish	Unpublish Prop
updateProp	PUT /props/{propId}	Update Prop

createProp

Prop createProp(CreatePropRequest)

Create Prop

Create a Prop and return the new Prop object.

Parameters

Name	Type	Description	Notes
CreatePropRequest	CreatePropRequest

Return type

Prop

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json

deleteProp

deleteProp(propId)

Delete Prop

Delete a Prop.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]

Return type

null (empty response body)

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getProp

Prop getProp(propId)

Get Prop

Returns a Prop object.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]

Return type

Prop

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

getPropPublishStatus

PropPublishStatus getPropPublishStatus(propId)

Get Prop Publish Status

Returns a PropPublishStatus object.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]

Return type

PropPublishStatus

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

listProps

List listProps(authorId, n, offset)

List Props

Returns a list Prop objects.

Parameters

Name	Type	Description	Notes
authorId	String	Must be a valid user ID.	[default to null]
n	Integer	The number of objects to return.	[optional] [default to 60]
offset	Integer	A zero-based offset from the default object sorting from where search results start.	[optional] [default to null]

Return type

List

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

publishProp

PropPublishStatus publishProp(propId)

Publish Prop

Publish a Prop and return the updated PropPublishStatus object.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]

Return type

PropPublishStatus

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

unpublishProp

PropPublishStatus unpublishProp(propId)

Unpublish Prop

Unpublish a Prop and return the updated PropPublishStatus object.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]

Return type

PropPublishStatus

Authorization

authCookie

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

updateProp

Prop updateProp(propId, UpdatePropRequest)

Update Prop

Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` if this value is not blank.

Parameters

Name	Type	Description	Notes
propId	String	Prop ID.	[default to null]
UpdatePropRequest	UpdatePropRequest

Return type

Prop

Authorization

authCookie

HTTP request headers

• Content-Type: application/json
• Accept: application/json