Изменить событие


POST /v1/events/{event_id}

Группа: События


Описание

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

Тело запроса

Список изменённых параметров события

EditEvent

ticket_types: TicketTypeRequest[]
Список видов билетов

TicketTypeRequest

id: integer
Номер существующего типа билета

price: integer
Цена существующего типа билета

status: string
Статус типа билета

name: string
Название типа билета

description: string
Описание типа билета

sale_starts_at: string (date-time)
Дата начала продажи типа билета

sale_ends_at: string (date-time)
Дата окончания продажи типа билета

send_personal_links: boolean
Категория билетов с отправкой персональных ссылок

limit: boolean
Ограничение на количество билетов этого типа

 
 

name: string
Название события

description_short: string
Краткое описание/подзаголовок события

description_html: string
Полное описание с html-тегами

starts_at: string
Дата начала события в формате ISO

ends_at: string
Дата окончания события в формате ISO

categories: CategoryInclude[]
Список категорий, в которые входит событие

CategoryInclude

id: integer
Номер категории в Таймпаде

name: string
Название категории в Таймпаде

 
 

location: LocationInclude 
Место проведения события 

  • city: string
    Город проведения события
  • address: string
    Адрес проведения события 

poster_image_url: string
URL картинки события

properties: string[]
Список настроек события (например, мультианкета)

  • string

custom: object
Объект с дополнительными полями, специфичными для данной организации

questions: QuestionInclude[]
Список вопросов в анкете регистрации 

QuestionInclude

field_id: string
Уникальный текстовый идентификатор вопроса

is_mandatory: boolean
Является ли ответ на вопрос обязательным

status: string
Статус вопроса

name: string
Текст вопроса

comment: string
Подсказка под вопросом

type: string
Тип вопроса

possible_answers: string[]
Список ответов на вопрос

  • string
 
 

access_status: string
Статус доступа к событию

age_limit: string
Возрастное ограничение события

tickets_limit: integer
Максимальное количество человек, которые могут посетить событие. При достижении этого количества регистрация на событие закроется, даже если будут открытыми категории регистрации. Поставьте 0, чтобы снять ограничение. Учитывается количество как оплаченных, так и забронированных билетов.

personal_links: string[]
Список персональных ссылок для билетов

  • string

personal_link_title: boolean
Заголовок персональной ссылки (Например: Ваша ссылка на онлайн-трансляцию)

is_sending_free_tickets: boolean
Отправлять билеты на бесплатные регистрации

reservation_period: integer
Срок брони билета в часах. Нулевое значение соответствует неограниченному сроку 

 

 
 

Параметры

Имя Описание Тип Тип данных  
event_id Номер редактируемого события path integer

Ответ

Отредактированное событие

EventResponse

id: integer«required»
Уникальный номер события

created_at: string (date) 
Дата создания события

starts_at: string (date)«required»
Дата начала события

ends_at: string (date)
Дата конца события

name: string — «required»
Название события

description_short: string
Короткое описание события или подзаголовок

description_html: string
Полное описание события

url: string«required»
Адрес события в timepad

poster_image: ImageResponse«required»
Картинка события

  • default_url: string«required»
    Картинка стандартного размера
  • uploadcare_url: string«required»
    Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare

ad_partner_percent: integer
Процент, который получают партнёры за продажу билета на это событие

locale: string
Язык события по умолчанию

location: LocationResponse 
Место проведения события

  • country: string — «required»
    Название страны
  • city: string — «required»
    Название города
  • address: string — «required»
    Адрес проведения события
  • coordinates: number[] — «required»
    Широта и долгота для карт
    number

organization: OrganizationResponse 
Организация, проводящая событие

  • id: integer«required»
    Номер организации
  • name: string«required»
    Название организации
  • description_html: string«required»
    Описание организации
  • url: string«required»
    URL организации на сайте
  • logo_image: ImageResponse«required»
    Логотип
    • default_url: string — «required»
      Картинка стандартного размера
    • uploadcare_url: string — «required»
      Адрес картинки на uploadcare, к которому можно прибавлять запросы в формате uploadcare
  • subdomain: string — «required»
    URL-идентификатор организации в Таймпаде (***.timepad.ru)
  • permissions: string[]
    Настройки доступов для организаций
    string

categories: CategoryResponse[] — «required»
Категории события

CategoryResponse

id: integer«required»
Уникальный номер категории

name: string«required»
Название категории

 
 

tickets_limit: integer
Максимальное количество человек, которые могут посетить событие

ticket_types: TicketTypeResponse[]
Доступные типы билетов

TicketTypeResponse

id: integer — «required»
Уникальный номер типа билета

name: string«required»
Название типа билета

description: string
Описание типа билета

buy_amount_min: number — «required»
Минимальное количество билетов в одной покупке

buy_amount_max: number«required»
Максимальное количество билетов в одной покупке

price: number«required»
Цена билета

is_promocode_locked: boolean«required»
Закрыт ли этот тип билета введённым промокодом

remaining: integer«required»
Сколько билетов осталось

sale_ends_at: string (date) «required»
Дата окончания продажи типа билета

sale_starts_at: string (date)
Дата начала продажи типа билета

public_key: string«required»
Публичный ключ для расшифровки QR-кода билета этого типа

is_active: boolean«required»
Активность типа билета

ad_partner_profit: number
Партнёрская прибыль

send_personal_links: boolean
Отправка персональных ссылок

sold: number
Количество проданных билетов

attended: number
Количество посетивших людей

limit: number
Ограничение на количество билетов в этом типе билета

status: string
Статус типа билета

 
 

personal_links: string[]
Персональные ссылки. Доступно только при указании токена со разрешением view_private_events

  • string

questions: QuestionResponse[]
Вопросы, задающиеся при регистрации

QuestionResponse

field_id: integer — «required»
Уникальный текстовый идентификатор вопроса

name: string«required»
Текст вопроса

comment: string
Подсказка под вопросом

type: string, x ∈ { text , multiline_text , select_one , select_many , upload , agree } «required»
Тип вопроса

possible_answers: AnswerResponse[] — «required»
Список предлагаемых ответов (если вопрос предполагает такой список)

AnswerResponse

id: integer — «required»
Уникальный номер ответа

name: string — «required»
Текст ответа

 
 

is_mandatory: boolean«required»
Является ли ответ на вопрос обязательным

is_for_every_visitor: boolean — «required»
Выводить вопрос отдельно для каждого купленного билета

meta: object«required»
Дополнительные данные

 
 

age_limit: string
Возрастное ограничение события

widgets: WidgetResponse[]
Виджеты, доступные для события

WidgetResponse

code_html: string — «required»
Код вставки виджета в сайт

 
 

properties: string[]
Список особенностей события

  • string

moderation_status: string«required»
Статус модерации

access_status: string
Статус доступа к событию

registration_data: RegistrationDataResponse 
Обобщённые данные о билетах

  • price_max: number «required»
    Цена самого дорогого билета
  • price_min: number«required»
    Цена самого дешёвого билета
  • sale_ends_at: string (date)«required»
    Дата окончания продажи последней категории билета
  • tickets_total: integer«required»
    Количество забронированных, проданных и бесплатных билетов
  • tickets_limit: integer«required»
    Максимальное количество доступных билетов, независимо от типа билета
  • is_registration_open: boolean«required»
    Открыта ли регистрация

is_sending_free_tickets: boolean
Отправлять билеты на бесплатные регистрации

personal_link_title: string
Заголовок персональной ссылки. Доступно только при указании токена со разрешением view_private_events

reservation_period: integer
Срок брони билета в часах. Нулевое значение соответствует неограниченному сроку

 
 

Права доступа

Необходимые права доступа — edit_events

Эта статья была полезной?