Outreach

App · 20 actions

Read sales resources and manage Outreach prospects, accounts and tasks.

Actions

ActionWhat it does
Create accountCreate account.
Create prospectCreate prospect.
Create taskCreate task.
Delete accountDelete account.
Delete prospectDelete prospect.
Get accountGet account.
Get opportunityGet opportunity.
Get prospectGet prospect.
Get sequenceGet sequence.
Get taskGet task.
Get userGet user.
List accountsList accounts.
List opportunitiesList opportunities.
List prospectsList prospects.
List sequence statesList sequence states.
List sequencesList sequences.
List tasksList tasks.
List usersList users.
Update accountUpdate account.
Update prospectUpdate prospect.

Create account

Create account.

Inputs

Descriptiondescriptiontext
A custom description of the account.
Domaindomaintext
The company’s website domain (e.g. "`www.acme.com`").
NamenametextRequired
The name of the company (e.g. "Acme Corporation").

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create prospect

Create prospect.

Inputs

Companycompanytext
The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International).
Emailsemailslist
A list of email addresses associated with the prospect.
First namefirst_nametext
The first name of the prospect.
Last namelast_nametextRequired
The last name of the prospect.
Titletitletext
The title of the prospect.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Create task

Create task.

Inputs

Due atdue_atdate and time
The date and time the task is due.
Notenotetext
An optional note for the task.
Ownerowner_idnumberRequired
The Outreach user who will own the task.At least 1.
Task actiontask_actiontextRequired
The kind of work to do. This does not send a message or place a call.One of: action_item, call, email, in_person.
Prospect IDprospect_idnumber
The prospect this task is about. Leave empty for a standalone task.At least 1.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Delete account

Delete account.

Inputs

IdidnumberRequired
id.

Outputs

Result.

datanull
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Delete prospect

Delete prospect.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}

Get account

Get account.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get opportunity

Get opportunity.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get prospect

Get prospect.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get sequence

Get sequence.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get task

Get task.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Get user

Get user.

Inputs

IdidnumberRequired
id.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

List accounts

List accounts. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List opportunities

List opportunities. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List prospects

List prospects. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List sequence states

List sequence states. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List sequences

List sequences. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List tasks

List tasks. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

List users

List users. Returns one page; use the continuation value for more records.

Inputs

Limitlimitnumber
Records per page, 1 to 1000.From 1 to 1000.
Offsetoffsetnumber
Continuation offset from the previous page.At least 0.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": []
  },
  "has_more": false,
  "next_cursor": null
}

Update account

Update account.

Inputs

IdidnumberRequired
id.
Descriptiondescriptiontext
A custom description of the account.
Domaindomaintext
The company’s website domain (e.g. "`www.acme.com`").
Namenametext
The name of the company (e.g. "Acme Corporation").

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

Update prospect

Update prospect.

Inputs

IdidnumberRequired
id.
Companycompanytext
The name of the company the prospect works at. If associated with an account, this is the name of the account. (e.g. Acme International).
Emailsemailslist
A list of email addresses associated with the prospect.
First namefirst_nametext
The first name of the prospect.
Last namelast_nametext
The last name of the prospect.
Titletitletext
The title of the prospect.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "data": {
      "attributes": {},
      "id": 0,
      "relationships": {},
      "type": ""
    }
  },
  "has_more": false,
  "next_cursor": null
}

On this page