Update a contact
Aufruf, Parameter, Antwort und Fehler von PATCH /v1/contacts/{id}.
Zuletzt aktualisiert:
A JSON Merge Patch (RFC 7396): a field that is missing stays as it is, null clears it, tags replaces the list. A contact must keep an email address or a phone number. Accepts application/json and application/merge-patch+json. Needs write access to contacts.
Braucht den Scope propose und mindestens die Stufe write auf contacts. Diesen Zugriff bekommt nur ein Key, den die Leitung des Büros angelegt hat.
Aufruf
PATCH https://api.athaus.ai/v1/contacts/{id}Parameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
id | string (uuid) | ja | UUID of the contact. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
If-Match | string | nein | Only if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written. |
Rumpf
JSON mit Content-Type: application/json. Ein Feld, das die API nicht kennt, ist ein 400, und errors[].name nennt das Feld. Der Rumpf ist Pflicht.
| Feld | Typ | Beschreibung |
|---|---|---|
salutation | string | null | Eines von ms, mr, mx. |
firstName | string | null | |
lastName | string | null | |
company | string | null | |
email | string | null | At most one live contact per address in an office. |
phone | string | null | |
street | string | null | |
postalCode | string | null | |
city | string | null | |
tags | string[] | Replaces the whole list. Trimmed and de-duplicated, at most 30 are kept. |
Beispiel
curl -X PATCH "https://api.athaus.ai/v1/contacts/0190f3a2-7c1e-7b0e-9a41-5d2f6e8c3b17" \
-H "Authorization: Bearer ath_live_..." \
-H "Content-Type: application/json" \
-d '{"phone":null,"city":"Potsdam"}'Antwort
Bei Erfolg kommt 200 mit Contact.
Contact
| Feld | Typ | Beschreibung |
|---|---|---|
object | string | Immer contact. |
id | string | UUID of the contact. |
salutation | string | null | Eines von ms, mr, mx. |
firstName | string | null | |
lastName | string | null | |
displayName | string | How the contact is named in every list: last name first, or what makes the contact reachable. |
company | string | null | |
email | string | null | |
phone | string | null | |
street | string | null | |
postalCode | string | null | |
city | string | null | |
tags | string[] | |
source | string | Where the contact came from, for example manual, an import or a connected system. |
createdAt | string (date-time) | |
updatedAt | string (date-time) |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
ETag | A strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_id, api_version_unsupported, invalid_input, invalid_body | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
409 | email_already_exists | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
412 | precondition_failed | The condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written. |
413 | payload_too_large | The request body is larger than 512 KB. |
415 | invalid_input | The request body is not JSON. Send Content-Type: application/json. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.