Files
2026-04-11 09:45:12 -05:00

3.3 KiB

Kit Routing Reference

App name: kit Base URL proxied: api.kit.com

API Path Pattern

/kit/v4/{resource}

Common Endpoints

List Subscribers

GET /kit/v4/subscribers

Query parameters:

  • per_page - Results per page (default: 500, max: 1000)
  • after - Cursor for next page
  • before - Cursor for previous page
  • status - Filter by: active, inactive, bounced, complained, cancelled, or all
  • email_address - Filter by specific email

Get Subscriber

GET /kit/v4/subscribers/{id}

Create Subscriber

POST /kit/v4/subscribers
Content-Type: application/json

{
  "email_address": "user@example.com",
  "first_name": "John"
}

Update Subscriber

PUT /kit/v4/subscribers/{id}
Content-Type: application/json

{
  "first_name": "Updated Name"
}

List Tags

GET /kit/v4/tags

Create Tag

POST /kit/v4/tags
Content-Type: application/json

{
  "name": "new-tag"
}

Update Tag

PUT /kit/v4/tags/{id}
Content-Type: application/json

{
  "name": "updated-tag-name"
}

Delete Tag

DELETE /kit/v4/tags/{id}

Tag a Subscriber

POST /kit/v4/tags/{tag_id}/subscribers
Content-Type: application/json

{
  "email_address": "user@example.com"
}

Remove Tag from Subscriber

DELETE /kit/v4/tags/{tag_id}/subscribers/{subscriber_id}

List Subscribers with Tag

GET /kit/v4/tags/{tag_id}/subscribers

List Forms

GET /kit/v4/forms

Add Subscriber to Form

POST /kit/v4/forms/{form_id}/subscribers
Content-Type: application/json

{
  "email_address": "user@example.com"
}

List Form Subscribers

GET /kit/v4/forms/{form_id}/subscribers

List Sequences

GET /kit/v4/sequences

Add Subscriber to Sequence

POST /kit/v4/sequences/{sequence_id}/subscribers
Content-Type: application/json

{
  "email_address": "user@example.com"
}

List Broadcasts

GET /kit/v4/broadcasts

List Segments

GET /kit/v4/segments

List Custom Fields

GET /kit/v4/custom_fields

Create Custom Field

POST /kit/v4/custom_fields
Content-Type: application/json

{
  "label": "Company"
}

Update Custom Field

PUT /kit/v4/custom_fields/{id}
Content-Type: application/json

{
  "label": "Company Name"
}

Delete Custom Field

DELETE /kit/v4/custom_fields/{id}

List Email Templates

GET /kit/v4/email_templates

List Purchases

GET /kit/v4/purchases

List Webhooks

GET /kit/v4/webhooks

Create Webhook

POST /kit/v4/webhooks
Content-Type: application/json

{
  "target_url": "https://example.com/webhook",
  "event": {"name": "subscriber.subscriber_activate"}
}

Delete Webhook

DELETE /kit/v4/webhooks/{id}

Notes

  • Kit API uses V4 (V3 is deprecated)
  • Subscriber IDs are integers
  • Custom field keys are auto-generated from labels
  • Uses cursor-based pagination with after and before parameters
  • Delete operations return 204 No Content
  • Bulk operations (>100 items) are processed asynchronously

Resources