T
Tick Up
Nhà phát triển
Đăng ký tài khoản
Tài liệu API

Email

Tick Up xử lý mọi email mà ứng viên nhận — gửi tay một lần, kích hoạt tự động theo vòng, broadcast chiến dịch, và chuỗi drip nhiều bước.

Ba cách gửi

  • Gửi một lần — một email cho một ứng viên, tùy chọn gắn với một đơn ứng tuyển. POST /api/v1/emails/send.
  • Chiến dịch — broadcast cho nhiều ứng viên cùng lúc. Có theo dõi, giới hạn tốc độ, gộp trùng. Tạo bằng POST /api/v1/campaigns, rồi dispatch bằng POST /api/v1/campaigns/{campaign_id}/send.
  • Chuỗi drip — automation nhiều bước, kích hoạt khi đăng ký và tiếp tục theo lịch (ví dụ ngày 0, ngày 3, ngày 7) cho đến khi ứng viên phản hồi, được tuyển, hoặc hoàn tất chuỗi.

Template email

Template lưu nội dung email tái sử dụng với các placeholder biến như {{candidate.full_name}} hoặc {{job.title}}. Biến được tra cứu khi gửi theo ngữ cảnh tương ứng. GET /api/v1/emails/templates liệt kê chúng; POST /api/v1/emails/templates tạo một template (subject + body HTML + danh sách biến).

Gửi một email đơn

POST /api/v1/emails/send gửi một email ngay lập tức. Cung cấp template_id (render phía server) hoặc cặp subject + body_html (gửi nguyên xi). Truyền application_id để cấp ngữ cảnh ứng viên + job cho biến template. reply_to mặc định là một địa chỉ duy nhất dưới reply.tickup.vn để theo dõi phản hồi của ứng viên — chỉ ghi đè khi bạn biết mình đang làm gì.

shell
curl -X POST https://tickup-api.onrender.com/api/v1/emails/send \
  -H "Authorization: Bearer $TICKUP_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "tu.nguyen@example.com",
    "template_id": "tpl_phone_screen_invite",
    "application_id": "1a2b3c4d-...-5e6f"
  }'

Chiến dịch

Một campaign là broadcast một-lần đến một audience xác định (audience group, danh sách applicant của một job, hoặc danh sách candidate ID tự do). Campaign được gửi theo lô với gộp trùng tích hợp — cùng một ứng viên không bao giờ nhận hai lần từ một campaign, và ứng viên blacklist/trùng lặp bị bỏ qua.

Tạo campaign ở trạng thái draft bằng POST /api/v1/campaigns, rồi bắt đầu gửi bằng POST /api/v1/campaigns/{campaign_id}/send. Dispatch trả về ngay; việc gửi thật sự chạy nền. Poll campaign để xem trạng thái.

Chuỗi drip

Một chuỗi drip là một loạt bước email kích hoạt theo lịch sau khi đăng ký. Hữu ích cho chiến dịch nurture (làm ấm talent pool) hoặc tiết lộ dần (từ chối → đăng ký mạng cựu ứng viên → pitch vị trí tương lai).

Đăng ký bằng POST /api/v1/drip-sequences/{sequence_id}/enroll. Các bước sau kích hoạt tự động; ứng viên blacklist hoặc bị đánh dấu trùng bị bỏ qua im lặng. Để dừng tiến trình của một ứng viên, dùng POST /api/v1/drip-sequences/{sequence_id}/enrollments/{enrollment_id}/stop (kết thúc) hoặc .../enrollments/{enrollment_id}/pause (có thể tiếp tục). Các lần gửi trước vẫn nằm trong email log dù chọn cách nào.

Email log & phản hồi

Log được giới hạn theo từng ứng viên, không cross-tenant. Dùng GET /api/v1/emails/logs/candidate/{candidate_id} để liệt kê lịch sử outbound của một ứng viên (delivery, open, click, bounce, trạng thái reply) và GET /api/v1/emails/logs/{log_id} cho một tin nhắn. Phản hồi nằm tại GET /api/v1/emails/candidate/{candidate_id}/replies — mỗi phản hồi liên kết về email outbound gốc qua reply_token.

Email mang theo (BYO)

Với các lần gửi nhạy cảm, bạn có thể kết nối inbox Gmail hoặc Microsoft 365 để tin nhắn đi ra từ địa chỉ của chính sender (không phải tickup.vn). Một khi đã kết nối qua UI, API tự động định tuyến các lần gửi của họ qua OAuth. GET /api/v1/email-integrations liệt kê mailbox đã kết nối của user; DELETE /api/v1/email-integrations/{integration_id} thu hồi kết nối (các lần gửi sau fall back về sender mặc định của tenant).

  • Webhooks — lắng nghe open, click, reply, và bounce.
  • Tài liệu đầy đủ — mọi endpoint template, campaign, và drip bao gồm quản lý audience group.
    Email | Tick Up Developers