Добавить своё поле в документ контент-завода

Добавляет поле в документ завода, которого нет в стандартном наборе. Нужен, когда в бриф надо писать свою пометку.

Scope

content_factory:write

Заголовки

Content-Type: application/json
X-Api-Key — ключ проекта
Idempotency-Key — для повторного запроса с тем же результатом

Добавить своё поле в документ контент-завода

POST /v1/document-custom-fields/create. Scope content_factory:write.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Здесь поле документа: запрос и ответ на одном вызове.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "name": "Повод"
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "id": "56565656-5656-4565-8565-565656565656",
    "name": "Повод",
    "key": "occasion",
    "fieldType": "text",
    "projectId": "11111111-1111-4111-8111-111111111111",
    "createdAt": "2026-10-16T09:00:00.000Z",
    "updatedAt": "2026-10-16T09:12:00.000Z"
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/document-custom-fields/create" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "name": "Повод"}}'

Ошибки

401 INVALID_API_KEY — нет ключа или ключ отозван.
403 FORBIDDEN_SCOPE — у ключа нет content_factory:write.
403 PROJECT_MISMATCH — в теле другой проект.
429 RATE_LIMIT_EXCEEDED — заголовок Retry-After.
400 VALIDATION_ERROR — не хватает поля в data.

Ограничения

Проект и пользователь берутся из ключа. Чужой data.projectId отвечает 403 PROJECT_MISMATCH.

Scope

Заголовки

Добавить своё поле в документ контент-завода

Запрос

Ответ (успех, 200)

Пример cURL

Ошибки

Ограничения

См. также