Kit tools
The 13 Kit operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List subscribersGETLists the subscribers with their id, email, first name, state and custom fields, only the active ones by default. Look one up by email_address. The response has subscribers and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create subscriberPOSTCreates an active subscriber. When the email address already belongs to a subscriber, it updates the first name of that subscriber instead. It adds no tag: use Apply tag next.
- Update subscriberPUTUpdates the email address, first name or custom fields of a subscriber. A custom field key that does not exist in the account makes the request fail.
- List tagsGETLists the tags with their id, name and creation date. The response has tags and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create tagPOSTCreates a tag and returns it with its id. When a tag with the same name exists, ignoring case, it returns that tag instead of a duplicate.
- Apply tagPOSTApplies a tag to an existing subscriber, found by email address. Automations of the account that start with this tag run for the subscriber. Create the subscriber first with Create subscriber.
- List formsGETLists the forms and landing pages with their id, name, type and embed URL, only the active ones by default. The response has forms and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- List segmentsGETLists the segments with their id and name. Segments are built in the Kit app, and their ids target a broadcast in subscriber_filter. The response has segments and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- List broadcastsGETLists the broadcasts with their id, subject, content, status, send_at, targeting and email template. The response has broadcasts and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Create broadcastPOSTCreates a broadcast email as a draft, or schedules it when send_at is set. It goes to every subscriber, or only to the segments and tags in subscriber_filter. Returns the broadcast with its id.
- Update broadcastPUTUpdates a draft or scheduled broadcast. Send subject and content on every update, copied from List broadcasts when they do not change. Setting send_at schedules the sending, and null takes the broadcast back to draft.
- List broadcast statsGETReturns, for each broadcast with its id, subject and send_at, the recipients, opens, open rate, clicks, click rate, unsubscribes and sending status. The response has broadcasts and pagination; while has_next_page is true, pass pagination.end_cursor as after.
- Get growth statsGETReturns the subscribers at the end of the period, the new subscribers, the cancellations and the net new subscribers between starting and ending, counted in the sending time zone of the account. The default period is the last 90 days.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
