Обновление кода в группе промокодов

Изменяет строковое значение кода в указанной группе промокодов.

Возвращает 409 Conflict, если новый код уже используется в другой активной группе с пересекающимся периодом действия.

Request

PATCH

https://api.kit.yandex.net/v1/promocode_groups/{group_id}/codes/{code_id}

Body

application/json
{
  "code": "SUMMER25"
}

Name

Description

code

Type: string

Новое значение кода. Длина от 3 до 20 символов. Допустимые символы:

  • заглавные латинские буквы;
  • цифры;
  • !@#$%^&*()_-=+.

Pattern: ^[A-ZА-ЯЁ0-9!@#$%^&*()_\-=+]{3,20}$

Example: SUMMER25

Responses

200 OK

Код успешно обновлен.

Body

application/json
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d0",
  "code": "WELCOME10",
  "usage_count": 3,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

Name

Description

code

Type: string

Строковое значение кода промокода.

Example: WELCOME10

created_at

Type: string<date-time>

Дата и время создания кода (RFC 3339).

Example: 2024-01-01T00:00:00Z

id

Type: PromocodeGroupCodeID

Уникальный идентификатор кода промокода.

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d0

updated_at

Type: string<date-time>

Дата и время последнего изменения кода (RFC 3339).

Example: 2024-06-01T12:00:00Z

usage_count

Type: integer

Количество использований данного кода.

PromocodeGroupCodeID

Уникальный идентификатор кода промокода.

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d0

400 Bad Request

Некорректный запрос.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

401 Unauthorized

Не авторизован.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

404 Not Found

Ресурс не найден.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

409 Conflict

Конфликт — новый код уже используется в другой активной группе с пересекающимся периодом действия.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name

Description

code

Type: string

Example: VALIDATION_ERROR

message

Type: string

Example: Invalid input

trace_id

Type: string

Уникальный идентификатор запроса для отладки.

Example: 00000000000000000000000000000000