Update a List via the API

AhaSend Go SDK

package main

import (
  "context"
  "fmt"
  "log"
  "os"

  "github.com/AhaSend/ahasend-go"
  "github.com/AhaSend/ahasend-go/api"
  "github.com/AhaSend/ahasend-go/models/requests"
  "github.com/google/uuid"
)

func main() {
  client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY")))
  accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID"))
  ctx := context.Background()

  listID := uuid.MustParse("11111111-1111-4111-8111-111111111111")

  // Only the fields you set change; an empty tags slice clears the tags.
  response, _, err := client.ListsAPI.UpdateList(ctx, accountID, listID, requests.UpdateListRequest{
    Name: ahasend.String("Product updates"),
    Tags: &[]string{},
  })
  if err != nil {
    log.Fatalf("Error updating list: %v", err)
  }
  fmt.Printf("Updated list %s\n", response.Name)
}

import { AhaSendClient } from "@ahasend/sdk";

const client = AhaSendClient.fromEnv();
const listId = "00000000-0000-4000-8000-000000000010";
const list = await client.lists.update(listId, { name: "Product news", tags: [] });
console.log("List updated.", { id: list.id, name: list.name });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ]
  ]),
  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;
}

HttpResponse<String> response = Unirest.put("https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "object": "contact_list",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "contact_count": 1
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

PUT

accounts

{account_id}

lists

{list_id}

AhaSend Go SDK

package main

import (
  "context"
  "fmt"
  "log"
  "os"

  "github.com/AhaSend/ahasend-go"
  "github.com/AhaSend/ahasend-go/api"
  "github.com/AhaSend/ahasend-go/models/requests"
  "github.com/google/uuid"
)

func main() {
  client := api.NewAPIClient(api.WithAPIKey(os.Getenv("AHASEND_API_KEY")))
  accountID := uuid.MustParse(os.Getenv("AHASEND_ACCOUNT_ID"))
  ctx := context.Background()

  listID := uuid.MustParse("11111111-1111-4111-8111-111111111111")

  // Only the fields you set change; an empty tags slice clears the tags.
  response, _, err := client.ListsAPI.UpdateList(ctx, accountID, listID, requests.UpdateListRequest{
    Name: ahasend.String("Product updates"),
    Tags: &[]string{},
  })
  if err != nil {
    log.Fatalf("Error updating list: %v", err)
  }
  fmt.Printf("Updated list %s\n", response.Name)
}

import { AhaSendClient } from "@ahasend/sdk";

const client = AhaSendClient.fromEnv();
const listId = "00000000-0000-4000-8000-000000000010";
const list = await client.lists.update(listId, { name: "Product news", tags: [] });
console.log("List updated.", { id: list.id, name: list.name });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ]
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "tags": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}",
  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([
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        '<string>'
    ]
  ]),
  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;
}

HttpResponse<String> response = Unirest.put("https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.ahasend.com/v2/accounts/{account_id}/lists/{list_id}")

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  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ]\n}"

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

{
  "object": "contact_list",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "contact_count": 1
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

The AhaSend API changes one list. Access requires lists:write. Fields:

A field that you leave out or send as null does not change.
tags replaces all stored tags. An empty array removes them.
name, description and tags follow the same rules as in Create List. A field that you cannot write is refused with 400, and the message names it.
A stored value that is outside these rules still reads back as it is. The API refuses it only when you send it back in an update.

Authorizations

Authorization

string

header

required

API key for authentication. Non-empty Security Requirement values are AhaSend API-key roles. Roles listed within one requirement object are jointly required; separate requirement objects are alternatives.

Path Parameters

account_id

string<uuid>

required

Account ID

list_id

string<uuid>

required

List ID

Body

application/json

A partial list update. An omitted or null property leaves the stored value unchanged; a present tags array replaces the stored tags, and an empty one clears them. A property that is not writable is rejected with 400 naming it.

name

string | null

Trimmed before it is measured and stored, exactly as on create. The bound counts characters rather than bytes, and a name that is empty after trimming is rejected.

Required string length: 1 - 255

description

string | null

Trimmed and bounded exactly as on create.

Maximum string length: 1000

Response

Updated list

A static, private, single opt-in container of contacts, and the unit a campaign targets.

object

enum<string>

required

Object type identifier

Available options:

contact_list

string<uuid>

required

Unique identifier for the list

created_at

string<date-time>

required

When the list was created

updated_at

string<date-time>

required

When the list was last updated

name

string

required

List name; names are not unique within an account

description

string

required

Free-text description; empty when none was given

Overview

API reference

Webhooks

Message Routing

API v1 (legacy)

Update a List via the API

Authorizations

Path Parameters

Body

Response

​Related Guides

Authorizations

Path Parameters

Body

Response

Related Guides