ledger.v2

Add metadata to an account

post/v2/{ledger}/accounts/{address}/metadata

Path parameters

ledgerstring required
Example:ledger001

Name of the ledger.

addressstring required
Example:users:001

Exact address of the account. It must match the following regular expressions pattern:

^\w+(:\w+)*$

Query parameters

dryRunboolean
Example:true

Set the dry run mode. Dry run mode doesn't add the logs to the database or publish a message to the message broker.

schemaVersionstring
Example:v1.0.0

Schema version to use for validation

Headers

Idempotency-Keystring

Use an idempotency key

Request body

V2Metadata required

Arbitrary key/value pairs attached to the resource

Example request

{
  "admin": "true"
}

Response

No Content

Changes

Changed in 4 of the 53 revisions of this API.52

  • 2945092328b921See the full diff
    • added the new SCHEMA_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • added the new SCHEMA_NOT_SPECIFIED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • added the new optional query request parameter schemaVersion

      new-optional-request-parameter

    • added the new OUTDATED_SCHEMA enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • removed the BUCKET_OUTDATED enum value from the errorCode response property for the response status default

      response-property-enum-value-removed

    • added the new BUCKET_OUTDATED enum value to the errorCode response property for the response status default

      response-property-enum-value-added

    • added the new LEDGER_ALREADY_EXISTS enum value to the errorCode response property for the response status default

      response-property-enum-value-added