Modifier un contact

PATCH /api/v1/contacts/{contactId} Modifie l'identité d'un contact. Seuls deux champs sont acceptés : Un champ que vous n'envoyez pas reste inchangé.
Le statut n'est pas modifiable ici. Un status envoyé dans le corps est ignoré — il ne change jamais l'état d'abonnement. Utilisez /unsubscribe et /resubscribe, qui sont des actes explicites.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

ChampTypeObligatoireDescription
firstNamestringnonJusqu'à 100 caractères, null l'efface
lastNamestringnonJusqu'à 100 caractères, null l'efface

Exemple

bash
curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" -H "content-type: application/json" \
  -d '{"firstName":"Camille","lastName":"Dubois"}' \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID"

Réponse

  • 200 OK — l'appel a réussi.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
  • 404 Not Found — ressource inexistante, ou elle appartient à une autre organisation. L'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.idstringIdentifiant unique du contact
data.emailstringSon adresse — unique au sein de sa liste
data.firstNamestringnull
data.lastNamestringnull
data.statusstringpending, subscribed, unsubscribed, bounced, complained
data.listIdstringLa liste à laquelle il appartient
data.listobject{id, name} de cette liste
data.tagsarray{id, name} de chaque tag porté
data.createdAtstringDate de création ISO
data.updatedAtstringDate ISO de la dernière modification

Exemple de réponse

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "email": "ada@example.com",
    "firstName": "Ada",
    "lastName": "Lovelace",
    "status": "subscribed",
    "listId": "0b7c51e8",
    "list": {
      "id": "0b7c51e8",
      "name": "Newsletter"
    },
    "tags": [
      {
        "id": "7c2ef4b1",
        "name": "vip"
      }
    ],
    "createdAt": "2026-08-23T10:22:05.000Z",
    "updatedAt": "2026-08-23T10:22:05.000Z"
  }
}

Voir aussi