Zola API

POST https://cotlet.dev/api/v1/zola/list_guests

Returns the guests on your guest list, each with the list they are on, the events they are invited to and their reply per event. Contact details are left out unless include_contact is true. Use guest_id from each item in the other tools.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/list_guests \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("zola", "list_guests")

const result = await cotlet.call('zola', 'list_guests');

cotlet call zola list_guests

Example response

{
  "guests": [
    {
      "guest_id": "gst_a41c07",
      "name": "Maria Example",
      "list": "definitely_invited",
      "events": [
        {
          "event_id": "evt_ceremony",
          "rsvp": "attending"
        },
        {
          "event_id": "evt_reception",
          "rsvp": "no_response"
        }
      ]
    },
    {
      "guest_id": "gst_a41c08",
      "name": "Tom Example",
      "list": "definitely_invited",
      "events": [
        {
          "event_id": "evt_ceremony",
          "rsvp": "declined"
        }
      ]
    }
  ]
}

POST https://cotlet.dev/api/v1/zola/list_events

Returns the events from "Your Events" in Zola: ceremony, reception, rehearsal dinner and any others you added. Use event_id from each item in the RSVP and invite tools. Guests can only RSVP to events they are invited to.

Parameters

No parameters.

Request

curl -X POST https://cotlet.dev/api/v1/zola/list_events \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("zola", "list_events")

const result = await cotlet.call('zola', 'list_events');

cotlet call zola list_events

Example response

{
  "events": [
    {
      "event_id": "evt_ceremony",
      "type": "Ceremony",
      "name": "Wedding Ceremony",
      "date": "2027-06-12",
      "start_time": "15:00"
    },
    {
      "event_id": "evt_reception",
      "type": "Reception",
      "name": "Dinner and Dancing",
      "date": "2027-06-12",
      "start_time": "18:00"
    }
  ]
}

POST https://cotlet.dev/api/v1/zola/track_rsvps

Returns the replies for one event with each guest's status, meal choice and answers to the questions you added to the event. Online RSVPs from your wedding website and replies you recorded by hand are both included. Meal totals are counted from the attending guests.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/track_rsvps \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"evt_reception","status":"no_response"}'

result = client.call("zola", "track_rsvps", {"event_id":"evt_reception","status":"no_response"})

const result = await cotlet.call('zola', 'track_rsvps', {"event_id":"evt_reception","status":"no_response"});

cotlet call zola track_rsvps --data '{"event_id":"evt_reception","status":"no_response"}'

Example response

{
  "event_id": "evt_reception",
  "counts": {
    "attending": 2,
    "declined": 1,
    "no_response": 1
  },
  "meals": {
    "Chicken": 1,
    "Fish": 1
  },
  "rsvps": [
    {
      "guest_id": "gst_a41c07",
      "name": "Maria Example",
      "status": "attending",
      "meal_choice": "Chicken"
    },
    {
      "guest_id": "gst_a41c08",
      "name": "Tom Example",
      "status": "attending",
      "meal_choice": "Fish"
    },
    {
      "guest_id": "gst_a41c09",
      "name": "Ana Example",
      "status": "declined",
      "meal_choice": null
    },
    {
      "guest_id": "gst_a41c10",
      "name": "Sam Example",
      "status": "no_response",
      "meal_choice": null
    }
  ]
}

POST https://cotlet.dev/api/v1/zola/list_gifts

Returns the gifts in your gift tracker with the fields Zola's CSV download has: order number, name, quantity, value, gift message, giver's address, order status and thank-you note status. Use gift_id from each item in mark_thank_you_sent.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/list_gifts \
  -H "Authorization: Bearer $COTLET_API_KEY"

result = client.call("zola", "list_gifts")

const result = await cotlet.call('zola', 'list_gifts');

cotlet call zola list_gifts

Example response

{
  "gifts": [
    {
      "gift_id": "gft_8f21c4",
      "order_number": "ZO-100412",
      "name": "Dutch Oven",
      "quantity": 1,
      "value": 389,
      "giver": "Alex Example",
      "message": "Congratulations!",
      "address": "12 Example Street, Springfield, IL 62701",
      "order_status": "delivered",
      "thank_you": "not_sent"
    },
    {
      "gift_id": "gft_8f21d9",
      "order_number": "ZO-100417",
      "name": "Honeymoon Fund",
      "quantity": 1,
      "value": 150,
      "giver": "Sam Example",
      "message": "Have a great trip.",
      "address": "4 Sample Road, Portland, OR 97201",
      "order_status": "completed",
      "thank_you": "not_sent"
    }
  ]
}

POST https://cotlet.dev/api/v1/zola/add_guest

Adds a guest to "Definitely Invited" or "Maybe" and returns the new guest_id. A plus-one is added as a second guest in the same party. Nothing is sent to anyone, so add_guest runs without asking first. Events are set with invite_guest_to_event.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/add_guest \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"first name","last_name":"last name"}'

result = client.call("zola", "add_guest", {"first_name":"first name","last_name":"last name"})

const result = await cotlet.call('zola', 'add_guest', {"first_name":"first name","last_name":"last name"});

cotlet call zola add_guest --data '{"first_name":"first name","last_name":"last name"}'

Example response

{
  "guest_id": "gst_b7720e",
  "name": "Maria Example",
  "list": "definitely_invited",
  "plus_one": {
    "guest_id": "gst_b7720f",
    "name": "Tom Example"
  },
  "status": "added"
}

POST https://cotlet.dev/api/v1/zola/update_guest_address

Replaces the mailing address of one guest, the address shown on the "Address Envelopes" page. Nothing is sent to the guest, so it runs without asking first, and calling it again with the old address undoes it.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/update_guest_address \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"guest_id":"guest_8c41d2","address":"address"}'

result = client.call("zola", "update_guest_address", {"guest_id":"guest_8c41d2","address":"address"})

const result = await cotlet.call('zola', 'update_guest_address', {"guest_id":"guest_8c41d2","address":"address"});

cotlet call zola update_guest_address --data '{"guest_id":"guest_8c41d2","address":"address"}'

Example response

{
  "guest_id": "gst_a41c07",
  "address": {
    "address_1": "12 Example Street",
    "address_2": null,
    "city": "Springfield",
    "state_province": "IL",
    "postal_code": "62701",
    "country_code": "US"
  },
  "status": "updated"
}

POST https://cotlet.dev/api/v1/zola/invite_guest_to_event

Adds an event to the events a guest is invited to, the choice you make on the "Invite Guests to Events" tab. Guests can only RSVP to events they are invited to. It sends no message, so it runs without asking first.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/invite_guest_to_event \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"event_8c41d2","guest_id":"guest_8c41d2"}'

result = client.call("zola", "invite_guest_to_event", {"event_id":"event_8c41d2","guest_id":"guest_8c41d2"})

const result = await cotlet.call('zola', 'invite_guest_to_event', {"event_id":"event_8c41d2","guest_id":"guest_8c41d2"});

cotlet call zola invite_guest_to_event --data '{"event_id":"event_8c41d2","guest_id":"guest_8c41d2"}'

Example response

{
  "guest_id": "gst_a41c07",
  "event_id": "evt_reception",
  "invited": true
}

POST https://cotlet.dev/api/v1/zola/record_rsvp

Records the reply of one guest to one event, the same as entering it under "Track RSVPs". The guest must be invited to the event, and meal_choice must be one of the options set on it. It changes only your own records and one more call corrects it, so it runs without asking first.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/record_rsvp \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_id":"evt_reception","guest_id":"gst_a41c07","status":"attending","meal_choice":"Vegetarian"}'

result = client.call("zola", "record_rsvp", {"event_id":"evt_reception","guest_id":"gst_a41c07","status":"attending","meal_choice":"Vegetarian"})

const result = await cotlet.call('zola', 'record_rsvp', {"event_id":"evt_reception","guest_id":"gst_a41c07","status":"attending","meal_choice":"Vegetarian"});

cotlet call zola record_rsvp --data '{"event_id":"evt_reception","guest_id":"gst_a41c07","status":"attending","meal_choice":"Vegetarian"}'

Example response

{
  "guest_id": "gst_a41c07",
  "event_id": "evt_reception",
  "status": "attending",
  "meal_choice": "Vegetarian",
  "recorded": true
}

POST https://cotlet.dev/api/v1/zola/mark_mail_sent

Updates the mail tracking on the "Address Envelopes" page for one guest. It does not mail anything and reaches no one, so it runs without asking first.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/mark_mail_sent \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"guest_id":"guest_8c41d2","type":"save_the_date"}'

result = client.call("zola", "mark_mail_sent", {"guest_id":"guest_8c41d2","type":"save_the_date"})

const result = await cotlet.call('zola', 'mark_mail_sent', {"guest_id":"guest_8c41d2","type":"save_the_date"});

cotlet call zola mark_mail_sent --data '{"guest_id":"guest_8c41d2","type":"save_the_date"}'

Example response

{
  "guest_id": "gst_a41c07",
  "type": "save_the_date",
  "mailed": true
}

POST https://cotlet.dev/api/v1/zola/mark_thank_you_sent

Sets the thank-you note status of the gifts you pass, as the gift tracker does for one gift at a time. Set sent to false to undo. It changes only your tracker and nothing goes to the giver, so it runs without asking first.

Parameters

Request

curl -X POST https://cotlet.dev/api/v1/zola/mark_thank_you_sent \
  -H "Authorization: Bearer $COTLET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"gift_ids":["gft_8f21c4","gft_8f21d9"],"sent":true}'

result = client.call("zola", "mark_thank_you_sent", {"gift_ids":["gft_8f21c4","gft_8f21d9"],"sent":True})

const result = await cotlet.call('zola', 'mark_thank_you_sent', {"gift_ids":["gft_8f21c4","gft_8f21d9"],"sent":true});

cotlet call zola mark_thank_you_sent --data '{"gift_ids":["gft_8f21c4","gft_8f21d9"],"sent":true}'

Example response

{
  "updated": [
    {
      "gift_id": "gft_8f21c4",
      "gift": "Dutch Oven",
      "giver": "Alex Example",
      "thank_you": "sent"
    },
    {
      "gift_id": "gft_8f21d9",
      "gift": "Honeymoon Fund",
      "giver": "Sam Example",
      "thank_you": "sent"
    }
  ]
}