Skip to main content

​
Event pages

​
Overview

Event pages control the public-facing content shown on an event’s landing page at https://app.animo.co/{company-slug}/event/{event-slug} — tagline, description, header image, support email, and attendee visibility. These endpoints apply to organizing events only, nested under /event/{organizingEvent}. Subscription: Pro plan required. Upgrade at https://app.animo.co/admin/settings/billing. The page object is also embedded on organizing event show and update responses — see Events.

​
Endpoints

​
Show event page

  • Method: GET
  • Path: /api/v1/{company}/event/{organizingEvent}/page
  • Scope: events:read
  • Subscription: Pro plan (USE_API)
Returns the event page if one exists, or an empty page object with default/null values if none has been created yet.

​
Path parameters

NameTypeDescription
companystringCompany sqid
organizingEventstringOrganizing event slug

​
Response 200

{
  "data": {
    "tagline": "The future of HR tech",
    "description": "<p>Join us for a full day of demos and networking.</p>",
    "support_email": "[email protected]",
    "header_image": "https://cdn.example.com/events/header.jpg",
    "show_attendees": true,
    "unsplash_data": null
  }
}

​
Response fields

FieldTypeDescription
taglinestring|nullShort headline on the event page
descriptionstring|nullHTML description (sanitized on read)
support_emailstring|nullContact email shown on the public page
header_imagestring|nullHeader image URL
show_attendeesbooleanWhether registered attendees are visible
unsplash_dataobject|nullUnsplash attribution data — present only when header image is from Unsplash

​
Errors

StatusWhen
401Missing or invalid token
403Missing scope, subscription, or company access
404Event not found or not an organizing event

​
Update event page

  • Method: POST
  • Path: /api/v1/{company}/event/{organizingEvent}/page
  • Scope: events:update
  • Subscription: Pro plan (USE_API)
Creates the event page if it does not exist, then applies the supplied fields.

​
Content type

Use multipart/form-data when uploading header_image. Use application/json for text-only updates.

​
Request body

See the request body table below for field requirements.
FieldRequiredDescription
taglineNoShort headline (max 255 chars)
descriptionNoHTML description
support_emailNoValid email address (max 255 chars)
show_attendeesNoBoolean
header_imageNoImage file — jpg, jpeg, png, gif, webp, avif, or apng; min width 320px
All fields are optional (partial update). Omit a field to leave it unchanged.

​
Example (multipart)

POST /api/v1/{company}/event/{event-slug}/page
Authorization: Bearer {token}
Content-Type: multipart/form-data

tagline=The future of HR tech
description=<p>Join us for a full day of demos.</p>
[email protected]
show_attendees=true
[email protected]

​
Response 200

Returns the updated EventPageResource.

​
Errors

StatusWhen
422Validation failure (invalid email, image too small, etc.)
403Missing events:update scope