Skip to content

Apply Wikilink changes

POST
/api/v1/notes/wikilinks/{id}/apply
curl --request POST \
--url https://example.com/api/v1/notes/wikilinks/example/apply \
--header 'Authorization: Bearer <token>'

Requires the User who created the preview. It updates Notes that still match the preview and reports conflicts. It returns 404 when the preview is missing or 409 when its state does not allow changes. Route: /api/v1/notes/wikilinks/{id}/apply. Inputs: id. Do not automatically replay this operation after an uncertain result.

id
required
string

Conversion operation ID

Media typeapplication/json
object
conflicts
required
integer format: int64
id
required
string
processed
required
integer format: int64
remaining
required
integer format: int64
state
required
string
undo_available
required
boolean
Examplegenerated
{
"conflicts": 1,
"id": "example",
"processed": 1,
"remaining": 1,
"state": "example",
"undo_available": true
}
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
"error": {
"code": "bad_request"
}
}
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
"error": {
"code": "bad_request"
}
}