Update Blocklist Note

PATCH

blocklist

customers

{entry_id}

notes

{note_id}

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const blockedCustomerNote = await client.blocklist.customers.notes.update('note_id', {
  entry_id: 'entry_id',
  text: 'text',
});

console.log(blockedCustomerNote.id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
blocked_customer_note = client.blocklist.customers.notes.update(
    note_id="note_id",
    entry_id="entry_id",
    text="text",
)
print(blocked_customer_note.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	blockedCustomerNote, err := client.Blocklist.Customers.Notes.Update(
		context.TODO(),
		"entry_id",
		"note_id",
		dodopayments.BlocklistCustomerNoteUpdateParams{
			NoteRequest: dodopayments.NoteRequestParam{
				Text: dodopayments.F("text"),
			},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", blockedCustomerNote.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.blocklist.customers.notes.BlockedCustomerNote;
import com.dodopayments.api.models.blocklist.customers.notes.NoteRequest;
import com.dodopayments.api.models.blocklist.customers.notes.NoteUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        NoteUpdateParams params = NoteUpdateParams.builder()
            .entryId("entry_id")
            .noteId("note_id")
            .noteRequest(NoteRequest.builder()
                .text("text")
                .build())
            .build();
        BlockedCustomerNote blockedCustomerNote = client.blocklist().customers().notes().update(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.blocklist.customers.notes.BlockedCustomerNote
import com.dodopayments.api.models.blocklist.customers.notes.NoteRequest
import com.dodopayments.api.models.blocklist.customers.notes.NoteUpdateParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: NoteUpdateParams = NoteUpdateParams.builder()
        .entryId("entry_id")
        .noteId("note_id")
        .noteRequest(NoteRequest.builder()
            .text("text")
            .build())
        .build()
    val blockedCustomerNote: BlockedCustomerNote = client.blocklist().customers().notes().update(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

blocked_customer_note = dodo_payments.blocklist.customers.notes.update("note_id", entry_id: "entry_id", text: "text")

puts(blocked_customer_note)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $blockedCustomerNote = $client->blocklist->customers->notes->update(
    'note_id', entryID: 'entry_id', text: 'text'
  );

  var_dump($blockedCustomerNote);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Blocklist.Customers.Notes;

DodoPaymentsClient client = new();

NoteUpdateParams parameters = new()
{
    EntryID = "entry_id",
    NoteID = "note_id",
    Text = "text",
};

var blockedCustomerNote = await client.Blocklist.Customers.Notes.Update(parameters);

Console.WriteLine(blockedCustomerNote);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let entry_id = "entry_id";
    let note_id = "note_id";
    let result = client
        .blocklist()
        .customers()
        .notes()
        .update()
        .entry_id(entry_id)
        .note_id(note_id)
        .body(dodopayments::models::InvoicesAddNoteParams {
                text: Some("text".to_string()),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request PATCH \
  --url https://test.dodopayments.com/blocklist/customers/{entry_id}/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>"
}
'

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "note": "<string>",
  "author_email": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Send your API key as a bearer token: Authorization: Bearer <api_key>. A test mode key starts with dodo_test_, for example dodo_test_AbCd1234EfGh5678.<secret>. A live mode key starts with dodo_live_. Use a test mode key on test.dodopayments.com and a live mode key on live.dodopayments.com. Keys from before these tags have no tag and operate as before.

Path Parameters

entry_id

string

required

Blocklist entry id

note_id

string

required

Note id

Body

application/json

text

string

required

Response

created_at

string<date-time>

required

string

required

note

string

required

author_email

string | null

updated_at

string<date-time> | null

Last modified on October 28, 2026

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const blockedCustomerNote = await client.blocklist.customers.notes.update('note_id', {
  entry_id: 'entry_id',
  text: 'text',
});

console.log(blockedCustomerNote.id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
blocked_customer_note = client.blocklist.customers.notes.update(
    note_id="note_id",
    entry_id="entry_id",
    text="text",
)
print(blocked_customer_note.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	blockedCustomerNote, err := client.Blocklist.Customers.Notes.Update(
		context.TODO(),
		"entry_id",
		"note_id",
		dodopayments.BlocklistCustomerNoteUpdateParams{
			NoteRequest: dodopayments.NoteRequestParam{
				Text: dodopayments.F("text"),
			},
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", blockedCustomerNote.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.blocklist.customers.notes.BlockedCustomerNote;
import com.dodopayments.api.models.blocklist.customers.notes.NoteRequest;
import com.dodopayments.api.models.blocklist.customers.notes.NoteUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        NoteUpdateParams params = NoteUpdateParams.builder()
            .entryId("entry_id")
            .noteId("note_id")
            .noteRequest(NoteRequest.builder()
                .text("text")
                .build())
            .build();
        BlockedCustomerNote blockedCustomerNote = client.blocklist().customers().notes().update(params);
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.blocklist.customers.notes.BlockedCustomerNote
import com.dodopayments.api.models.blocklist.customers.notes.NoteRequest
import com.dodopayments.api.models.blocklist.customers.notes.NoteUpdateParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val params: NoteUpdateParams = NoteUpdateParams.builder()
        .entryId("entry_id")
        .noteId("note_id")
        .noteRequest(NoteRequest.builder()
            .text("text")
            .build())
        .build()
    val blockedCustomerNote: BlockedCustomerNote = client.blocklist().customers().notes().update(params)
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

blocked_customer_note = dodo_payments.blocklist.customers.notes.update("note_id", entry_id: "entry_id", text: "text")

puts(blocked_customer_note)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $blockedCustomerNote = $client->blocklist->customers->notes->update(
    'note_id', entryID: 'entry_id', text: 'text'
  );

  var_dump($blockedCustomerNote);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Blocklist.Customers.Notes;

DodoPaymentsClient client = new();

NoteUpdateParams parameters = new()
{
    EntryID = "entry_id",
    NoteID = "note_id",
    Text = "text",
};

var blockedCustomerNote = await client.Blocklist.Customers.Notes.Update(parameters);

Console.WriteLine(blockedCustomerNote);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let entry_id = "entry_id";
    let note_id = "note_id";
    let result = client
        .blocklist()
        .customers()
        .notes()
        .update()
        .entry_id(entry_id)
        .note_id(note_id)
        .body(dodopayments::models::InvoicesAddNoteParams {
                text: Some("text".to_string()),
                ..Default::default()
            })
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request PATCH \
  --url https://test.dodopayments.com/blocklist/customers/{entry_id}/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>"
}
'

{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "note": "<string>",
  "author_email": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

API Reference

Checkout Sessions

Payments

Subscriptions

Invoices

Discounts

Licenses

Entitlements

Customers

Customer Wallets

Customer Blocklist

Products

Localized Pricing

Addons

Credit Entitlements

Meters

Usage Events

Refunds

Disputes

Payouts

Balance Ledger

Moderation

Brands

Webhooks

Miscellaneous

Product Collections

Authorizations

Path Parameters

Body

Response