Skip to content

Update Collection Metadata

This page documents the API endpoint for updating the metadata (name and URI) of an existing Collection on the In Process protocol. This endpoint allows artists to update the collection name and metadata URI associated with their Collections.

Note: Only Collection admins can update the metadata.

Endpoint

POST https://inprocess.world/api/collection/uri

Authentication

Include an API key in the x-api-key header for authorization:

x-api-key: <artist_api_key>
Show more

See Create an Artist API Key for how to create API keys.

Request Body

Send a JSON object with the following fields:

{
  "collection": {
    "collectionAddress": "string", // Contract address of the Collection
    "chainId": "number" // Chain ID (optional, default: Base 8453)
  },
  "newCollectionName": "string", // New name of the Collection
  "newUri": "string" // New metadata URI (e.g., Arweave URI)
}

Body Parameters

NameTypeRequiredDescription
collectionobjectYesObject containing the Collection identifier
collection.collectionAddressstringYesThe contract address of the Collection to update
collection.chainIdnumberNoThe Chain Id of the Collection (default: Base 8453)
newCollectionNamestringYesThe new name of the Collection
newUristringYesThe new metadata URI to set for the Collection

Example Requests

cURL
curl -X POST https://inprocess.world/api/collection/uri \
  -H "Content-Type: application/json" \
  -H "x-api-key: art_sk_3fnm4...f6w4" \
  -d '{
    "collection": {
      "collectionAddress": "0x06a701Ae65582B92Af48cDff45a8B20DcA3714cA"
    },
    "newCollectionName": "My Collection",
    "newUri": "ar://new-metadata-uri"
  }'

Example Success Response

{
  "hash": "0xTransactionHash",
  "chainId": 8453
}

Response Fields

NameTypeDescription
hashstringTransaction hash of the update operation
chainIdnumberChain ID where the transaction was executed

Example Error Response

If an error occurs (e.g., invalid input, unauthorized access, or transaction failure), the API returns:

{
  "message": "Invalid input",
  "errors": [
    {
      "field": "collection.collectionAddress",
      "message": "Required"
    }
  ]
}

Or for server errors:

{
  "message": "failed to update collection metadata"
}

Notes

  • The metadata update is executed onchain via a smart account transaction
  • Only Collection admins can update the metadata
  • The transaction is processed using Coinbase CDP (Coinbase Developer Platform)