API docs v1

API reference / Resource

Outreach

49 endpoints

  1. GET /v1/brands/{brand_id}/campaigns List campaigns
  2. POST /v1/brands/{brand_id}/campaigns Create a campaign
  3. GET /v1/brands/{brand_id}/campaigns/{campaign_id} Retrieve a campaign
  4. PATCH /v1/brands/{brand_id}/campaigns/{campaign_id} Update, launch, pause or end a campaign
  5. GET /v1/brands/{brand_id}/campaigns/{campaign_id}/preview Preview a campaign's launch
  6. GET /v1/brands/{brand_id}/campaigns/{campaign_id}/timeline A campaign's days
  7. GET /v1/brands/{brand_id}/contact-lists List contact lists
  8. POST /v1/brands/{brand_id}/contact-lists Create a contact list
  9. GET /v1/brands/{brand_id}/contact-lists/{list_id} Retrieve a contact list
  10. PATCH /v1/brands/{brand_id}/contact-lists/{list_id} Update a contact list
  11. GET /v1/brands/{brand_id}/contact-lists/{list_id}/contacts List a contact list's contacts
  12. POST /v1/brands/{brand_id}/contact-lists/{list_id}/contacts Add contacts to a static list
  13. DELETE /v1/brands/{brand_id}/contact-lists/{list_id}/contacts/{contact_id} Remove a contact from a static list
  14. POST /v1/brands/{brand_id}/contact-lists/previews Preview a dynamic list's filter
  15. GET /v1/brands/{brand_id}/contacts List outreach contacts
  16. POST /v1/brands/{brand_id}/contacts Add an outreach contact
  17. PATCH /v1/brands/{brand_id}/contacts Tag several contacts
  18. GET /v1/brands/{brand_id}/contacts/{contact_id} Retrieve an outreach contact
  19. PATCH /v1/brands/{brand_id}/contacts/{contact_id} Update an outreach contact
  20. GET /v1/brands/{brand_id}/contacts/{contact_id}/citations List the pages a contact was found on
  21. GET /v1/brands/{brand_id}/email-sequences List email sequences
  22. POST /v1/brands/{brand_id}/email-sequences Create an email sequence
  23. GET /v1/brands/{brand_id}/email-sequences/{sequence_id} Retrieve an email sequence
  24. PATCH /v1/brands/{brand_id}/email-sequences/{sequence_id} Update an email sequence
  25. POST /v1/brands/{brand_id}/email-sequences/{sequence_id}/steps/{step_id}/variants Add an A/B variant to a step
  26. GET /v1/brands/{brand_id}/email-sequences/{sequence_id}/variants List a sequence's A/B variants
  27. PATCH /v1/brands/{brand_id}/email-sequences/{sequence_id}/variants/{variant_id} Update an A/B variant
  28. GET /v1/brands/{brand_id}/email-templates List email templates
  29. POST /v1/brands/{brand_id}/email-templates Create an email template
  30. PATCH /v1/brands/{brand_id}/email-templates/{template_id} Update an email template
  31. GET /v1/brands/{brand_id}/emails List outreach emails
  32. POST /v1/brands/{brand_id}/emails Save an outreach email draft
  33. GET /v1/brands/{brand_id}/emails/{email_id} Retrieve an outreach email
  34. PATCH /v1/brands/{brand_id}/emails/{email_id} Update an outreach email
  35. POST /v1/brands/{brand_id}/emails/{email_id}/reply-drafts Draft a reply in a thread
  36. POST /v1/brands/{brand_id}/emails/{email_id}/sends Send an outreach email
  37. GET /v1/brands/{brand_id}/emails/{email_id}/thread Read an email's thread
  38. POST /v1/brands/{brand_id}/emails/ai-compositions Write a pitch with AI
  39. GET /v1/brands/{brand_id}/emails/replies List outreach replies
  40. GET /v1/brands/{brand_id}/emails/summary Outreach email counts
  41. GET /v1/brands/{brand_id}/outreach/authors List the most cited authors
  42. POST /v1/brands/{brand_id}/outreach/citations Add pages to Backlink outreach
  43. PATCH /v1/brands/{brand_id}/outreach/citations/{citation_id} Set a cited page's contact
  44. POST /v1/brands/{brand_id}/outreach/citations/{citation_id}/backlink-verifications Check a cited page for a backlink
  45. POST /v1/brands/{brand_id}/outreach/processing-jobs Analyze cited pages for outreach
  46. POST /v1/me/mailbox-connection-links Mint a link that connects Gmail
  47. GET /v1/me/mailboxes List mailboxes
  48. PATCH /v1/me/mailboxes/{mailbox_id} Update a mailbox
  49. DELETE /v1/me/mailboxes/{mailbox_id} Disconnect a mailbox