Docs API reference Editing API reference
Editing Change what is known about an item, lock fields, match, refresh and delete (item:edit).
Paths are relative to /api/v1 on your server.
Edit an item Fields edited by hand are locked against the next refresh unless unlocked.
Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Item 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeDelete an item Deleting media files needs library.allow_media_deletion and a fresh delete token.
Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)deleteFilesquery confirmTokenquery string
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it.
MEDIA_DELETION_DISABLED: files were asked for and the server does not allow it application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopePOST /items/{id} /delete-token# Issue a short-lived token for deleting files Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)
200 Success. application/json · object 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeLock fields against refresh Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Item 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeAdd a marker Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
201 Success. application/json · Marker 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopePATCH /items/{id} /markers/{markerId} # Update a marker Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)markerId required path string (uuid)
200 Success. application/json · Marker 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeDELETE /items/{id} /markers/{markerId} # Remove a marker Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)markerId required path string (uuid)
204 Done; no body. 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeApply a provider match Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Item 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelope422 METADATA_MATCH_FAILED: the provider no longer knows the id application/json · ErrorEnvelopeGET /items/{id} /match-candidates# Search the providers for a match Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)qquery stringproviderquery string
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopePOST /items/{id} /optimize# Make an optimised copy Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeRefresh metadata from the providers Authorisation Bearer token or API key · Session cookie Parameter In Type Description id required path string (uuid)
200 Success. application/json · object 401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeRewrite a course’s outline Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · object 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeUnlock fields Authorisation Bearer token or API key · Session cookie Body application/json · objectParameter In Type Description id required path string (uuid)
200 Success. application/json · Item 400 VALIDATION_FAILED: the request did not match the schema; details.issues lists what. application/json · ErrorEnvelope401 UNAUTHENTICATED: no session, or the access token expired. application/json · ErrorEnvelope403 FORBIDDEN: the account lacks item:edit, or the library, label, age or schedule scope refuses it. application/json · ErrorEnvelope404 NOT_FOUND: no such thing, or not one the caller may see. application/json · ErrorEnvelopeNo endpoint here matches. Try another word, or look in another area .