ImportOS · Документація
Довідник API

PATCH /v1/contacts/{id}

Update a contact (partial)

Update a contact (partial)

Changes only the fields that are sent; omitted fields keep their values (no defaults are applied). Requires scope write:deals.

  • Автентифікація: заголовок Authorization: Bearer rv_live_... (API-ключі та scopes)
  • Потрібний scope: write:deals
Опис операції, параметрів і полів походить зі специфікації OpenAPI (openapi.json) і подається англійською, як у самому API.

Параметри

ПолеДеТипОбов’язк.Опис
idpathstring (uuid)такResource id (UUID).

Тіло запиту

ПолеТипОбов’язк.Опис
type"lead" | "client" | "partner"ні
fullNamestringні
ownerUserIdstring | null (uuid)ні
tagsstring[]ні
consentMarketingbooleanні
preferredChannel"telegram" | "viber" | "email" | "sms" | "webhook" | "in_app" | nullні
locale"uk" | "pl" | "en"ні
notesstring | nullні
utmobject | nullні

Відповіді

200

The updated contact.

application/json · Схема: ContactDetail

ПолеТипОбов’язк.Опис
contactobjectтак
contact.idstring (uuid)так
contact.type"lead" | "client" | "partner"так
contact.fullNamestringтак
contact.phonesstring[]такE.164.
contact.emailsstring[]так
contact.telegramIdstring | nullтак
contact.telegramUsernamestring | nullтак
contact.viberIdstring | nullтак
contact.source"site" | "telegram" | "instagram" | "referral" | "ads" | "manual" | "viber" | "widget" | "extension" | "api" | "import" | "marketplace"так
contact.ownerUserIdstring | null (uuid)так
contact.tagsstring[]так
contact.consentMarketingbooleanтак
contact.preferredChannel"telegram" | "viber" | "email" | "sms" | "webhook" | "in_app" | nullтак
contact.locale"uk" | "pl" | "en"так
contact.notesstring | nullтак
contact.createdAtstringтакISO 8601 date-time (UTC).
contact.updatedAtstringтакISO 8601 date-time (UTC).
ownerobjectтак
owner.idstring (uuid)так
owner.namestringтак
countsobjectтак
counts.dealsintegerтак
counts.openDealsintegerтак
counts.requestsintegerтак
counts.openTasksintegerтак

400

Invalid request parameters or body (code validation_error).

application/problem+json · Схема: Problem

401

Missing, malformed, unknown, revoked or expired API key (code unauthorized).

application/problem+json · Схема: Problem

403

The API key lacks the scope required by this endpoint (code insufficient_scope).

application/problem+json · Схема: Problem

404

No such contact in this tenant.

application/problem+json · Схема: Problem

422

Invalid phone/email or other field.

application/problem+json · Схема: Problem

429

Rate limit exceeded for the tenant plan (code rate_limited). Wait Retry-After seconds.

application/problem+json · Схема: Problem

На цій сторінці