Skip to main content
PATCH
/
v1
/
w3s
/
contracts
/
{id}
Update a contract
curl --request PATCH \
  --url https://api.circle.com/v1/w3s/contracts/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "First Contract",
  "description": "My first hello world contract",
  "archived": false
}'
{
  "data": {
    "contract": {
      "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
      "deployerWalletID": "f39e3dbd-84af-4d3d-b5ac-98fbe047ce6a",
      "deploymentTransactionId": "00ca46f3-c31b-4e3a-92a9-068d4ff26a63",
      "txHash": "0x4a25cc5e661d8504b59c5f38ba93f010e8518966f00e2ceda7955c4b8621357d",
      "abiJson": "[{\"inputs\": [],\"stateMutability\": \"nonpayable\",\"type\": \"constructor\"},...",
      "archived": false,
      "blockchain": "MATIC-AMOY",
      "contractAddress": "0x1e124d7384cd34448ea5907bd0052a79355ab5eb",
      "contractInputType": "IMPORT",
      "deployerAddress": "0x1bf9ad0cc2ad298c69a2995aa806ee832788218c",
      "deployerUserID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "deploymentErrorReason": "<string>",
      "deploymentErrorDetails": "<string>",
      "name": "First Contract",
      "description": "My first hello world contract",
      "status": "PENDING",
      "verificationStatus": "UNVERIFIED",
      "metadataLink": "https://ipfs.io/ipfs/Qme7ss3ARVgxv6rXqVPiikMJ8u2NLgmgszg13pYrDKEoiu",
      "updateDate": "2023-01-01T12:04:05Z",
      "createDate": "2023-01-01T12:04:05Z",
      "sourceCode": [
        {
          "fileName": "openzeppelin-solidity/contracts/math/SafeMath.sol",
          "fileContent": "pragma solidity ^0.4.24;\n\n/**\n * @title SafeMath\n * @dev Math operations with safety checks..."
        }
      ],
      "functions": [
        {
          "name": "approve",
          "stateMutability": "nonpayable",
          "type": "function",
          "inputs": [
            {
              "components": [
                "<any>"
              ],
              "indexed": true,
              "name": "to",
              "type": "address",
              "flattenedType": "<string>"
            }
          ],
          "outputs": [
            {
              "components": [
                "<any>"
              ],
              "indexed": true,
              "name": "to",
              "type": "address",
              "flattenedType": "<string>"
            }
          ]
        }
      ],
      "events": [
        {
          "name": "Approval",
          "type": "event",
          "anonymous": false,
          "inputs": [
            {
              "components": [
                "<any>"
              ],
              "indexed": true,
              "name": "to",
              "type": "address",
              "flattenedType": "<string>"
            }
          ]
        }
      ],
      "implementationContract": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Headers

​
X-Request-Id
string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Example:

"2adba88e-9d63-44bc-b975-9b6ae3440dde"

Path Parameters

​
id
string<uuid>
required

The universally unique identifier of the resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Body

application/json

Update contract properties request

​
name
string

The name for a contract. Must be alphanumeric [a-zA-Z0-9].

Example:

"First Contract"

​
description
string

The description for a contract.

Example:

"My first hello world contract"

​
archived
boolean

The archive state of the contract. If true, the contract will not be visible in your dashboard.

Example:

false

Response

Contract is updated.

​
data
object
required