com.atproto.repo.applyWrites

POST 
/xrpc/com.atproto.repo.applyWrites

This endpoint is part of the atproto PDS repository management APIs. Requests usually require authentication (unlike the com.atproto.sync.* endpoints), and are made directly to the user's own PDS instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

Apply a batch transaction of repository creates, updates, and deletes. Requires auth, implemented by PDS.

Request

application/json

Body

required

repo at-identifierrequired

The handle or DID of the repo (aka, current account).

validate boolean

Can be set to 'false' to skip Lexicon schema validation of record data across all operations, 'true' to require it, or leave unset to validate only for known Lexicons.

writes

object[]

required

Array [

oneOf

com.atproto.repo.applyWrites.create

collection nsidrequired

rkey string

Possible values: <= 15 characters

value required

com.atproto.repo.applyWrites.update

collection nsidrequired

rkey stringrequired

value required

com.atproto.repo.applyWrites.delete

collection nsidrequired

rkey stringrequired

]

swapCommit cid

If provided, the entire operation will fail if the current repo commit CID does not match this value. Used to prevent conflicting repo mutations.

Responses

200

OK

application/json

Schema

Schema

commit

object

cid cidrequired

rev stringrequired

results

object[]

Array [

oneOf

com.atproto.repo.applyWrites.createResult

uri at-urirequired

cid cidrequired

validationStatus string

Possible values: [valid, unknown]

com.atproto.repo.applyWrites.updateResult

uri at-urirequired

cid cidrequired

validationStatus string

Possible values: [valid, unknown]

com.atproto.repo.applyWrites.deleteResult

]

Example (from schema)

{
  "commit": {
    "cid": "string",
    "rev": "string"
  },
  "results": [
    {},
    {},
    {}
  ]
}

400

Bad Request

application/json

Schema

Schema

error stringrequired

Possible values: [InvalidRequest, ExpiredToken, InvalidToken, InvalidSwap]

message stringrequired

Example (from schema)

{
  "error": "InvalidRequest",
  "message": "string"
}

401

Unauthorized

application/json

Schema

Schema

error required
message stringrequired

Example (from schema)

{
  "message": "string"
}

Loading...