Документация · v1

Creodock API

Все операции
POSTИнтерфейс CreodockИдемпотентная команда

Создать: клиентов

Безопасно создаёт клиентов на основании переданного тела запроса.

OpenAPI: Create or edit a client contact

POSThttps://api.creodock.com/api/v1/organizations/{organizationId}/clients/{clientId}/contacts
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Создаёт ресурс или запускает команду, описанную в теле запроса.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
clientIdОбязательно
pathstring · uuid
ID клиента, полученный при создании клиента или в ответе списка клиентов.
Idempotency-KeyОбязательно
headerstring
Уникальный ключ команды. Используйте UUID и сохраняйте тот же ключ при безопасном повторе запроса.Минимальная длина: 16 · Максимальная длина: 128

Тело запроса

Обязательно для этой операции.

application/json

Схема: ClientContactRequest

ПолеТипОписание
idНеобязательно
string · uuid
Уникальный идентификатор объекта.
isPrimaryНеобязательно
boolean
Поле «isPrimary» в структуре запроса или ответа.
nameОбязательно
string
Отображаемое название.Минимальная длина: 1
telegramНеобязательно
string
Поле «telegram» в структуре запроса или ответа.
versionНеобязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Saved contact

application/json

Схема: MutationResult

ПолеТипОписание
idОбязательно
string · uuid
Уникальный идентификатор объекта.
versionНеобязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.
{
  "id": "00000000-0000-0000-0000-000000000000",
  "version": 1
}