Update a Contact 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()

  // Only the fields you set change. A nil attribute value deletes that key.
  response, _, err := client.ContactsAPI.UpdateContact(ctx, accountID, "user+tag@example.com", requests.UpdateContactRequest{
    FirstName:  ahasend.String("Jordan"),
    Attributes: map[string]any{"obsolete_key": nil},
  })
  if err != nil {
    log.Fatalf("Error updating contact: %v", err)
  }
  fmt.Printf("Updated contact %s\n", response.ID)
}

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

const client = AhaSendClient.fromEnv();
const idOrEmail = "User+Tag@Example.COM";
const contact = await client.contacts.update(idOrEmail, {
  unsubscribed: true,
  attributes: { obsolete: null },
});
console.log("Contact updated.", { id: contact.id, unsubscribed: contact.unsubscribed });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/contacts/{id_or_email} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "status_reason": "<string>",
  "unsubscribed": true,
  "attributes": {}
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/contacts/{id_or_email}"

payload = {
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "status_reason": "<string>",
    "unsubscribed": True,
    "attributes": {}
}
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}/contacts/{id_or_email}",
  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([
    'email' => 'jsmith@example.com',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'status_reason' => '<string>',
    'unsubscribed' => true,
    'attributes' => [
        
    ]
  ]),
  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}/contacts/{id_or_email}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"status_reason\": \"<string>\",\n  \"unsubscribed\": true,\n  \"attributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"status_reason\": \"<string>\",\n  \"unsubscribed\": true,\n  \"attributes\": {}\n}"

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

{
  "object": "contact",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "status": "enabled",
  "status_reason": "<string>",
  "unsubscribed": true,
  "unsubscribed_at": "2023-11-07T05:31:56Z",
  "attributes": {},
  "validation_status": "unvalidated",
  "last_validated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

PUT

accounts

{account_id}

contacts

{id_or_email}

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()

  // Only the fields you set change. A nil attribute value deletes that key.
  response, _, err := client.ContactsAPI.UpdateContact(ctx, accountID, "user+tag@example.com", requests.UpdateContactRequest{
    FirstName:  ahasend.String("Jordan"),
    Attributes: map[string]any{"obsolete_key": nil},
  })
  if err != nil {
    log.Fatalf("Error updating contact: %v", err)
  }
  fmt.Printf("Updated contact %s\n", response.ID)
}

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

const client = AhaSendClient.fromEnv();
const idOrEmail = "User+Tag@Example.COM";
const contact = await client.contacts.update(idOrEmail, {
  unsubscribed: true,
  attributes: { obsolete: null },
});
console.log("Contact updated.", { id: contact.id, unsubscribed: contact.unsubscribed });

curl --request PUT \
  --url https://api.ahasend.com/v2/accounts/{account_id}/contacts/{id_or_email} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "status_reason": "<string>",
  "unsubscribed": true,
  "attributes": {}
}
'

import requests

url = "https://api.ahasend.com/v2/accounts/{account_id}/contacts/{id_or_email}"

payload = {
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "status_reason": "<string>",
    "unsubscribed": True,
    "attributes": {}
}
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}/contacts/{id_or_email}",
  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([
    'email' => 'jsmith@example.com',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'status_reason' => '<string>',
    'unsubscribed' => true,
    'attributes' => [
        
    ]
  ]),
  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}/contacts/{id_or_email}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"status_reason\": \"<string>\",\n  \"unsubscribed\": true,\n  \"attributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"email\": \"jsmith@example.com\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"status_reason\": \"<string>\",\n  \"unsubscribed\": true,\n  \"attributes\": {}\n}"

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

{
  "object": "contact",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "status": "enabled",
  "status_reason": "<string>",
  "unsubscribed": true,
  "unsubscribed_at": "2023-11-07T05:31:56Z",
  "attributes": {},
  "validation_status": "unvalidated",
  "last_validated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

{
  "message": "Error message"
}

The AhaSend API changes one contact. Access requires contacts:write. {id_or_email} is the contact ID or its email address. Percent-encode an email address exactly once. See Name a contact in the path. Fields:

A field that you leave out or send as null does not change.
email changes the email address of the contact. An address that another contact of the account has is refused with 409.
attributes is merged into the stored attributes. A null value removes that key. Other values must match the types that you defined in the dashboard. See Attributes.

Unsubscribe:

unsubscribed: true stops campaigns to the contact on all lists. It does not change the contact’s memberships, and the contact no longer counts toward the contact_count of any list. There is no operation that removes a contact from all lists.
To unsubscribe the contact from one list only, use Add or Update a List Contact with subscription_status: "unsubscribed".
A change to unsubscribed does not add or remove a suppression.

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

id_or_email

string

required

Contact UUID or email address. Percent-encode an email exactly once as a path segment; SDK callers pass the raw email value.

Body

application/json

A partial contact update. Omitted or null scalar fields and a null attributes object leave stored values unchanged. A present attributes object is merged; a null member removes that attribute key.

string<email> | null

first_name

string | null

last_name

string | null

status

enum<string> | null

Available options:

enabled,

disabled,

blocked,

null

status_reason

string | null

unsubscribed

boolean | null

attributes

object | null

Show child attributes

Response

Updated contact

Public contact projection. Attribute reads are legacy-safe: values can contain null, booleans, numbers, strings, arrays, or nested objects even though new writes accept only canonical dashboard-defined values.

object

enum<string>

required

Object type identifier

Available options:

contact

string<uuid>

required

Unique identifier for the contact

created_at

string<date-time>

required

When the contact was created

updated_at

string<date-time>

required

When the contact was last updated

string<email>

required

Normalized contact email address

first_name

string

required

last_name

string

required

status

enum<string>

required

Available options:

enabled,

disabled,

blocked

status_reason

string

required

unsubscribed

boolean

required

unsubscribed_at

string<date-time> | null

required

attributes

object

required

Show child attributes

validation_status

enum<string>

required

Available options:

unvalidated,

valid,

invalid,

risky,

unknown

last_validated_at

string<date-time> | null

required

Overview

API reference

Webhooks

Message Routing

API v1 (legacy)

Update a Contact via the API

Authorizations

Path Parameters

Body

Response

​Related Guides

Authorizations

Path Parameters

Body

Response

Related Guides