Important!!!

From September 1, 2017 we switch the API to the new endpoint: api.reply.io. Make sure you change your preferences from run.reply.io/api to api.reply.io.

The article contains the list of Reply APIs and their use cases. There are two versions of the API - V1 and V2 that cover different functionality of the system. You can use both versions simultaneously. The time limit between API calls makes 10 seconds.

Reply API list

Get, update, delete contacts

  • Get the list of all contacts in your Reply account: GET /v1/people
  • Get a specific contact by their ID: GET /v1/people/{id}  
  • Get a specific contact by their email: GET /v1/people?email={email} 
  • Add or update existing contacts:   POST /v1/people 
  • Delete a specific contact by their ID: DELETE /v1/people/{id}
  • Delete a specific contact by their email:  DELETE/v1/people?email={email} 

Actions with contacts in campaign

  • Get the number of people that received at least one email per campaign: GET /v1/Stats/GetPeopleSentPerCampaign?campaignId={id}
  • Push an existing contact to campaign:  POST /v1/actions/pushtocampaign  
  • Add a new contact and push them to campaign: POST /v1/actions/addandpushtocampaign
  • Remove an existing contact from campaign by campaign id: POST /v1/actions/removepersonfromcampaignbyid
  • Remove an existing contact from all campaigns: POST /v1/actions/removepersonfromallcampaigns
  • Mark a contact as Replied in campaign: POST /v1/actions/markasreplied

Get campaigns

  • Get the list of campaigns: GET /v1/campaigns
  • Get campaign details by campaign ID: GET /v1/campaigns/{id}
  • Get campaign details by campaign name: GET /v1/campaigns?name={name}

Create and update campaigns

  • Create a new campaign in your Reply account: POST /v2/campaigns
  • Update an existing campaign by its ID: PATCH /v2/campaigns/{id}

Get, add, update, remove campaign steps

  • Get the list of campaign steps in an existing campaign: GET /v2/campaigns/:id/steps
  • Get a particular campaign step in an existing campaign: GET /v2/campaigns/:id/steps/:stepId
  • Add a new step to an existing campaign: POST /v2/campaigns/:id/steps
  • Update an existing step in existing campaign: PATCH /v2/campaigns/:id/steps
  • Remove an existing step from an existing campaign: DELETE /v2/campaigns/:id/steps/:stepId

Start and pause an existing campaign

  • Start an existing campaign by its id: POST /v2/campaigns/{id}/start 
  • Pause a running campaign by its id: POST /v2/campaigns/{id}/pause

Get contact fields

  • Get standard and custom fields for the contact: GET /v1/internal/variables

Get the list of email accounts

  • Get the list of email accounts connected to your Reply account: GET /v1/emailAccounts

Get Shared page URL

  • Get shared page url for the current user: GET /v1/SharedPageUrl 

Domain blacklisting

  • Get the list of blacklisted domains: GET /v1/blacklist
  • Add one domain to blacklist: POST /v1/blacklist
  • Remove one domain from blacklist: DELETE /v1/blacklist 

Get statistics for a particular contact

  • Get the detailed contact's statistics: GET /v1/stats/person?email={personEmail}
Did this answer your question?