Dynamic Links

get/api/dyn

Request

  • Base URL: https://addcal.co
  • URL: https://addcal.co/api/dyn
  • Auth: none required

Query parameters

uidstring required

Your Dynamic Link Key identifier.

Example:dk_abc123
servicestring required

Calendar service to redirect to. Accepted: google, apple, outlook, outlook_web, office365, yahoo, ics, manual.

Example:google
titlestring required

Event title. Max 255 characters.

Example:Team Standup
startstring required

Start date/time in ISO 8601 format.

Example:2026-06-15T14:00:00
endstring

End date/time in ISO 8601 format. Defaults to 1 hour after start if omitted.

Example:2026-06-15T15:00:00
durationinteger

Duration in minutes. Takes precedence over end.

Example:60
timezonestring

IANA timezone. Required for timed events.

Example:America/New_York
all_day_eventboolean

Set to true for all-day events.

descriptionstring

Event description. Max 2000 characters.

Example:Impedit voluptatem et autem voluptatem aspernatur.
locationstring

Physical address or virtual meeting URL. Max 255 characters.

Example:enim
alarminteger

Reminder in minutes before the event.

Example:15
recurringstring

RFC 5545 recurrence rule (RRULE).

Example:FREQ=WEEKLY;BYDAY=MO,WE,FR
transpstring

Busy status: OPAQUE (busy) or TRANSPARENT (free). Defaults to OPAQUE.

Example:OPAQUE

Request body

uidstring required
titlestring required

Must not be greater than 255 characters.

startstring required

Must be a valid date.

endstring nullable

Must be a valid date. Must be a date after or equal to <code>start</code>.

durationinteger nullable

Must be at least 1.

all_day_eventstring nullable
timezonestring required

Must be a valid time zone, such as <code>Africa/Accra</code>.

descriptionstring nullable

Must not be greater than 2000 characters.

locationstring nullable

Must not be greater than 255 characters.

alarminteger nullable

Must be at least 0.

recurringstring nullable
transp'TRANSPARENT' | 'OPAQUE' nullable
servicestring nullable

Example request

{
  "uid": "ut",
  "title": "vzwilwkuhzkmitz",
  "start": "2026-08-28T03:20:12",
  "end": "2027-11-15",
  "duration": 65,
  "timezone": "Africa/Khartoum",
  "description": "Illum cumque occaecati impedit in non non sed.",
  "location": "iwemjqgkzhvwhupodub",
  "alarm": 39,
  "recurring": "voluptates",
  "transp": "OPAQUE",
  "service": "ducimus"
}

Changes

No recorded changes to this operation across all 1 revision of this API.