Update Contract

Update contract

curl --request PUT \
  --url https://api.formo.so/v0/contracts/{chain}/{address} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "chain": 123,
  "name": "<string>",
  "abi": "<string>",
  "events": [
    {}
  ],
  "start_block": 4503599627370495,
  "include_in_pipeline": true
}
'

import requests

url = "https://api.formo.so/v0/contracts/{chain}/{address}"

payload = {
    "address": "<string>",
    "chain": 123,
    "name": "<string>",
    "abi": "<string>",
    "events": [{}],
    "start_block": 4503599627370495,
    "include_in_pipeline": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '<string>',
    chain: 123,
    name: '<string>',
    abi: '<string>',
    events: [{}],
    start_block: 4503599627370495,
    include_in_pipeline: true
  })
};

fetch('https://api.formo.so/v0/contracts/{chain}/{address}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.formo.so/v0/contracts/{chain}/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '<string>',
    'chain' => 123,
    'name' => '<string>',
    'abi' => '<string>',
    'events' => [
        [
                
        ]
    ],
    'start_block' => 4503599627370495,
    'include_in_pipeline' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.formo.so/v0/contracts/{chain}/{address}"

	payload := strings.NewReader("{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.formo.so/v0/contracts/{chain}/{address}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.formo.so/v0/contracts/{chain}/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "chain": 123,
  "address": "<string>",
  "abi": "<string>",
  "events": [
    {
      "anonymous": true,
      "inputs": [
        {}
      ],
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "include_in_pipeline": true,
  "start_block": 123
}

PUT

contracts

{chain}

{address}

Update contract

curl --request PUT \
  --url https://api.formo.so/v0/contracts/{chain}/{address} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "<string>",
  "chain": 123,
  "name": "<string>",
  "abi": "<string>",
  "events": [
    {}
  ],
  "start_block": 4503599627370495,
  "include_in_pipeline": true
}
'

import requests

url = "https://api.formo.so/v0/contracts/{chain}/{address}"

payload = {
    "address": "<string>",
    "chain": 123,
    "name": "<string>",
    "abi": "<string>",
    "events": [{}],
    "start_block": 4503599627370495,
    "include_in_pipeline": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    address: '<string>',
    chain: 123,
    name: '<string>',
    abi: '<string>',
    events: [{}],
    start_block: 4503599627370495,
    include_in_pipeline: true
  })
};

fetch('https://api.formo.so/v0/contracts/{chain}/{address}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.formo.so/v0/contracts/{chain}/{address}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'address' => '<string>',
    'chain' => 123,
    'name' => '<string>',
    'abi' => '<string>',
    'events' => [
        [
                
        ]
    ],
    'start_block' => 4503599627370495,
    'include_in_pipeline' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.formo.so/v0/contracts/{chain}/{address}"

	payload := strings.NewReader("{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.formo.so/v0/contracts/{chain}/{address}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.formo.so/v0/contracts/{chain}/{address}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"<string>\",\n  \"chain\": 123,\n  \"name\": \"<string>\",\n  \"abi\": \"<string>\",\n  \"events\": [\n    {}\n  ],\n  \"start_block\": 4503599627370495,\n  \"include_in_pipeline\": true\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>",
  "chain": 123,
  "address": "<string>",
  "abi": "<string>",
  "events": [
    {
      "anonymous": true,
      "inputs": [
        {}
      ],
      "name": "<string>",
      "type": "<string>"
    }
  ],
  "include_in_pipeline": true,
  "start_block": 123
}

Authorizations

Authorization

string

header

required

Workspace API key (e.g. formo_xxx). Create one in the Formo dashboard under Team Settings > API.

Headers

Idempotency-Key

string

Optional unique value (e.g. a UUID v4) that lets you safely retry POST/PUT/PATCH/DELETE requests. The first request runs normally; subsequent requests with the same key replay the stored response (status + body) for 24 hours, so retries can never double-create or double-charge. Two concurrent requests with the same key return 409 IDEMPOTENCY_IN_PROGRESS. Generate a fresh key per logical operation.

Maximum string length: 255

Path Parameters

chain

string

required

address

string

required

Body

application/json

address

string

required

chain

integer

required

name

string

required

abi

string

required

events

object[]

required

Maximum array length: 10

start_block

integer

Block height recorded on the contract. Omit to preserve the stored value. Note: the events pipeline currently opens every source at the chain head, so this does not backfill historical events.

Required range: 0 <= x <= 9007199254740991

include_in_pipeline

boolean

Whether to include this contract in the project contract-events pipeline. Omit to preserve the stored value; send false to keep the ABI cached for transaction decoding without indexing events.

Response

Contract updated

name

string

required

chain

integer

required

address

string

required

abi

string

required

events

object[]

required

Show child attributes

include_in_pipeline

boolean

required

Whether the contract is configured for the project contract-events pipeline. This is the desired membership, not live deployment state: use the deploy sidecar on the contract list to see what is currently deployed.

start_block

integer

API Documentation

Events API

Profiles API

Query API

Alerts API

Charts API

Contracts API

Segments API

Authorizations

Headers

Path Parameters

Body

Response