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

Creodock API

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

Выполнить действие: рабочая область

Выполняет разрешённое действие над рабочая область. Доступные действия зависят от текущего состояния объекта и прав вызывающей стороны.

OpenAPI: Submit, request changes, approve, or archive a creative version

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

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

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

  • Выполняет действие из тела запроса и может изменить состояние связанного объекта.
  • Поддерживает Idempotency-Key: повторяйте запрос с тем же ключом после сетевого сбоя.

Параметры

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

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

Тело запроса

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

application/json

Схема: CreativeActionRequest

ПолеТипОписание
actionОбязательно
string
Поле «action» в структуре запроса или ответа.Допустимо: submit, request_changes, approve, archiveПример: submit
messageНеобязательно
string
Поле «message» в структуре запроса или ответа.
reasonCodeНеобязательно
string
Поле «reasonCode» в структуре запроса или ответа.
versionОбязательно
integer · int64
Версия объекта для защиты от конфликтующих изменений.

Ответы

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

200

Updated creative

application/json

Схема: CreativeDetail

{
  "approvedVersion": {
    "assets": [],
    "author": {},
    "createdAt": "2026-09-05T12:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "number": 1
  },
  "aspectRatio": "string",
  "author": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "availableActions": [
    "string"
  ],
  "client": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "currentVersion": {
    "assets": [
      {}
    ],
    "author": {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    },
    "createdAt": "2026-09-05T12:00:00Z",
    "id": "00000000-0000-0000-0000-000000000000",
    "number": 1
  },
  "directionId": "00000000-0000-0000-0000-000000000000",
  "geo": "string",
  "id": "00000000-0000-0000-0000-000000000000",
  "language": "string",
  "number": "string",
  "reviewStatus": "draft",
  "reviewer": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "task": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string"
  },
  "title": "string",
  "type": "static",
  "updatedAt": "2026-09-05T12:00:00Z",
  "version": 1
}
409

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
409Конфликт состояния или версииПосле чтенияПолучите актуальный объект и повторите изменение.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}