AthausDocs

Update a contact

Request, parameters, response and errors of PATCH /v1/contacts/{id}.

Last updated:

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.

Requires the scope propose and at least the level write on contacts. Only a key created by the management of the office gets this access.

Request

PATCH https://api.athaus.ai/v1/contacts/{id}

Parameters

Path

NameTypeRequiredDescription
idstring (uuid)yesUUID of the contact.

Header

NameTypeRequiredDescription
Athaus-VersionstringnoOptional 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-MatchstringnoOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.

Request body

JSON with Content-Type: application/json. A field the API does not know is a 400, and errors[].name names the field. The body is required.

FieldTypeDescription
salutationstring | nullOne of ms, mr, mx.
firstNamestring | null
lastNamestring | null
companystring | null
emailstring | nullAt most one live contact per address in an office.
phonestring | null
streetstring | null
postalCodestring | null
citystring | null
tagsstring[]Replaces the whole list. Trimmed and de-duplicated, at most 30 are kept.

Example

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"}'

Response

On success the status is 200 with Contact.

Contact

FieldTypeDescription
objectstringAlways contact.
idstringUUID of the contact.
salutationstring | nullOne of ms, mr, mx.
firstNamestring | null
lastNamestring | null
displayNamestringHow the contact is named in every list: last name first, or what makes the contact reachable.
companystring | null
emailstring | null
phonestring | null
streetstring | null
postalCodestring | null
citystring | null
tagsstring[]
sourcestringWhere the contact came from, for example manual, an import or a connected system.
createdAtstring (date-time)
updatedAtstring (date-time)

Response headers

HeaderDescription
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
ETagA 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-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Errors

Every error arrives as problem details. Branch on code, not on title or detail.

StatusCodesMeaning
400invalid_id, api_version_unsupported, invalid_input, invalid_bodyInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409email_already_existsThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
413payload_too_largeThe request body is larger than 512 KB.
415invalid_inputThe request body is not JSON. Send Content-Type: application/json.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Keep reading

On this page