Operations (sample payloads)

Main operations
Copy

Add prospect to sequence
Copy

Add a prospect to a sequence in your Outreach account.

Sample Input

1{
2    "sequence_id": 123,
3    "prospect_id": 456,
4    "mailbox_id": 789
5}

Sample Output

1{
2    "data": {
3        "type": "sequenceState",
4        "id": 1234,
5        "attributes": {
6            "activeAt": "2023-05-15T10:30:00Z",
7            "bounceCount": 0,
8            "callCompletedAt": null,
9            "clickCount": 2,
10            "createdAt": "2023-05-15T10:30:00Z",
11            "deliverCount": 1,
12            "errorReason": null,
13            "failureCount": 0,
14            "negativeReplyCount": 0,
15            "neutralReplyCount": 0,
16            "openCount": 3,
17            "optOutCount": 0,
18            "pauseReason": null,
19            "positiveReplyCount": 1,
20            "repliedAt": "2023-05-16T14:45:00Z",
21            "replyCount": 1,
22            "scheduleCount": 3,
23            "state": "active",
24            "stateChangedAt": "2023-05-15T10:30:00Z",
25            "updatedAt": "2023-05-16T14:45:00Z"
26        },
27        "relationships": {
28            "calls": {
29                "links": {
30                    "related": "https://api.outreach.io/api/v2/sequenceStates/1234/calls"
31                }
32            },
33            "creator": {
34                "data": {
35                    "type": "user",
36                    "id": 5678
37                }
38            },
39            "mailbox": {
40                "data": {
41                    "type": "mailbox",
42                    "id": 789
43                }
44            },
45            "mailings": {
46                "links": {
47                    "related": "https://api.outreach.io/api/v2/sequenceStates/1234/mailings"
48                }
49            },
50            "prospect": {
51                "data": {
52                    "type": "prospect",
53                    "id": 456
54                }
55            },
56            "sequence": {
57                "data": {
58                    "type": "sequence",
59                    "id": 123
60                }
61            },
62            "sequenceStep": {
63                "data": {
64                    "type": "sequenceStep",
65                    "id": 9012
66                }
67            },
68            "tasks": {
69                "links": {
70                    "related": "https://api.outreach.io/api/v2/sequenceStates/1234/tasks"
71                }
72            }
73        },
74        "links": {
75            "self": "https://api.outreach.io/api/v2/sequenceStates/1234"
76        }
77    }
78}

Create account
Copy

Create an account in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "Acme Corporation",
4        "natural_name": "Acme Corp",
5        "company_type": "B2B",
6        "domain": "www.acmecorp.com",
7        "website_url": "https://www.acmecorp.com",
8        "custom_id": "ACME001",
9        "description": "Leading provider of innovative solutions",
10        "followers": "10000",
11        "founded_at": "1985-03-15",
12        "industry": "Technology",
13        "locality": "San Francisco, CA",
14        "number_of_employees": 500,
15        "named": true,
16        "linked_in_url": "https://www.linkedin.com/company/acmecorp",
17        "linked_in_employees": 520,
18        "tags": "tech,innovation,startup",
19        "custom_fields": {
20            "custom_1": "High Priority",
21            "custom_2": "West Coast",
22            "custom_3": "Enterprise"
23        }
24    },
25    "relationships": {
26        "owner": 12345
27    }
28}

Sample Output

1{
2    "data": {
3        "type": "account",
4        "id": 67890,
5        "attributes": {
6            "buyerIntentScore": 75,
7            "companyType": "B2B",
8            "createdAt": "2023-04-15T10:30:00Z",
9            "custom1": "High Priority",
10            "custom2": "West Coast",
11            "custom3": "Enterprise",
12            "customId": "ACME001",
13            "description": "Leading provider of innovative solutions",
14            "domain": "www.acmecorp.com",
15            "externalSource": "manual",
16            "followers": 10000,
17            "foundedAt": "1985-03-15",
18            "industry": "Technology",
19            "linkedInEmployees": 520,
20            "linkedInUrl": "https://www.linkedin.com/company/acmecorp",
21            "locality": "San Francisco, CA",
22            "name": "Acme Corporation",
23            "named": true,
24            "naturalName": "Acme Corp",
25            "numberOfEmployees": 500,
26            "tags": [
27                "tech",
28                "innovation",
29                "startup"
30            ],
31            "touchedAt": "2023-04-15T10:30:00Z",
32            "updatedAt": "2023-04-15T10:30:00Z",
33            "websiteUrl": "https://www.acmecorp.com"
34        },
35        "relationships": {
36            "creator": {
37                "data": {
38                    "type": "user",
39                    "id": 12345
40                }
41            },
42            "owner": {
43                "data": {
44                    "type": "user",
45                    "id": 12345
46                }
47            },
48            "prospects": {
49                "links": {
50                    "related": "https://api.outreach.io/api/v2/accounts/67890/prospects"
51                }
52            },
53            "tasks": {
54                "links": {
55                    "related": "https://api.outreach.io/api/v2/accounts/67890/tasks"
56                }
57            },
58            "updater": {
59                "data": {
60                    "type": "user",
61                    "id": 12345
62                }
63            }
64        },
65        "links": {
66            "self": "https://api.outreach.io/api/v2/accounts/67890"
67        }
68    }
69}

Create call
Copy

Create a new call in your outreach account.

Sample Input

1{
2    "attributes": {
3        "direction": "outbound",
4        "from": "+14155551234",
5        "to": "+14155555678",
6        "answered_at": "2023-05-15T14:30:00Z",
7        "completed_at": "2023-05-15T14:35:00Z",
8        "outcome": "completed",
9        "sequence_action": "advance",
10        "note": "Discussed product features and pricing",
11        "tags": [
12            "sales",
13            "follow-up"
14        ],
15        "recording_url": "https://example.com/recordings/call123.mp3"
16    },
17    "relationships": {
18        "call_disposition": 1,
19        "call_purpose": 2,
20        "prospect": 3456,
21        "user": 789
22    }
23}

Sample Output

1{
2    "data": {
3        "type": "call",
4        "id": 12345,
5        "attributes": {
6            "answeredAt": "2023-05-15T14:30:00Z",
7            "completedAt": "2023-05-15T14:35:00Z",
8            "createdAt": "2023-05-15T14:29:55Z",
9            "dialedAt": "2023-05-15T14:29:58Z",
10            "direction": "outbound",
11            "from": "+14155551234",
12            "to": "+14155555678",
13            "note": "Discussed product features and pricing",
14            "outcome": "completed",
15            "recordingUrl": "https://example.com/recordings/call123.mp3",
16            "sequenceAction": "advance",
17            "state": "completed",
18            "stateChangedAt": "2023-05-15T14:35:00Z",
19            "tags": [
20                "sales",
21                "follow-up"
22            ],
23            "updatedAt": "2023-05-15T14:35:05Z",
24            "userCallType": "outbound"
25        },
26        "relationships": {
27            "callDisposition": {
28                "data": {
29                    "type": "callDisposition",
30                    "id": 1
31                }
32            },
33            "callPurpose": {
34                "data": {
35                    "type": "callPurpose",
36                    "id": 2
37                }
38            },
39            "prospect": {
40                "data": {
41                    "type": "prospect",
42                    "id": 3456
43                }
44            },
45            "user": {
46                "data": {
47                    "type": "user",
48                    "id": 789
49                }
50            }
51        },
52        "links": {
53            "self": "https://api.outreach.io/api/v2/calls/12345"
54        }
55    }
56}

Create call disposition
Copy

Create a new call disposition in your outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "Follow-up Required",
4        "order": 2,
5        "outcome": "completed"
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "callDisposition",
4        "id": 123,
5        "attributes": {
6            "createdAt": "2023-05-15T14:30:00Z",
7            "name": "Follow-up Required",
8            "order": 2,
9            "outcome": "completed",
10            "updatedAt": "2023-05-15T14:30:00Z"
11        },
12        "relationships": {
13            "calls": {
14                "links": {
15                    "related": "https://api.outreach.io/api/v2/callDispositions/123/calls"
16                }
17            },
18            "creator": {
19                "data": {
20                    "type": "user",
21                    "id": 456
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/callDispositions/123"
27        }
28    }
29}

Create call purpose
Copy

Create a call purpose in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "Initial Contact",
4        "order": 1
5    }
6}

Sample Output

1{
2    "data": {
3        "type": "callPurpose",
4        "id": 12345,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "name": "Initial Contact",
8            "order": 1,
9            "updatedAt": "2023-05-15T10:30:00Z"
10        },
11        "relationships": {
12            "calls": {
13                "links": {
14                    "related": "https://api.outreach.io/api/v2/callPurposes/12345/calls"
15                }
16            },
17            "creator": {
18                "data": {
19                    "type": "user",
20                    "id": 67890
21                }
22            }
23        },
24        "links": {
25            "self": "https://api.outreach.io/api/v2/callPurposes/12345"
26        }
27    }
28}

Create compliance request
Copy

Create a new compliance request in your Outreach account.

Sample Input

1{
2    "requester_email": "john.doe@example.com",
3    "request_type": "Delete",
4    "object_type": "Prospect",
5    "request_object_email": "jane.smith@company.com"
6}

Sample Output

1{
2    "batch_compliance_request_uuid": "12345678-abcd-1234-efgh-987654321012"
3}

Create mailing
Copy

Create a new mailing in your outreach account.

Sample Input

1{
2    "attributes": {
3        "bodyHtml": "<html><body><h1>Hello {{prospect.firstName}},</h1><p>I hope this email finds you well. I wanted to reach out and discuss how our product can benefit your company.</p><p>Best regards,<br>{{user.firstName}}</p></body></html>",
4        "subject": "Introducing our solution for {{prospect.company}}",
5        "scheduledAt": "2023-06-15T10:00:00Z",
6        "trackLinks": true,
7        "trackOpens": true
8    },
9    "relationships": {
10        "mailbox": 1234,
11        "prospect": 5678,
12        "sequence": 9101,
13        "template": 1121
14    }
15}

Sample Output

1{
2    "data": {
3        "type": "mailing",
4        "id": 3141,
5        "attributes": {
6            "bodyHtml": "<html><body><h1>Hello {{prospect.firstName}},</h1><p>I hope this email finds you well. I wanted to reach out and discuss how our product can benefit your company.</p><p>Best regards,<br>{{user.firstName}}</p></body></html>",
7            "bodyText": "Hello {{prospect.firstName}},\n\nI hope this email finds you well. I wanted to reach out and discuss how our product can benefit your company.\n\nBest regards,\n{{user.firstName}}",
8            "bouncedAt": null,
9            "clickCount": 0,
10            "clickedAt": null,
11            "createdAt": "2023-06-14T15:30:00Z",
12            "deliveredAt": null,
13            "errorBacktrace": null,
14            "errorReason": null,
15            "followUpTaskScheduledAt": null,
16            "followUpTaskType": null,
17            "mailboxAddress": "sales@example.com",
18            "mailingType": "sequence",
19            "markedAsSpamAt": null,
20            "messageId": "<20230614153000.1234.5678@outreach.io>",
21            "notifyThreadCondition": null,
22            "notifyThreadScheduledAt": null,
23            "notifyThreadStatus": null,
24            "openCount": 0,
25            "openedAt": null,
26            "overrideSafetySettings": false,
27            "references": [],
28            "repliedAt": null,
29            "retryAt": null,
30            "retryCount": 0,
31            "retryInterval": null,
32            "scheduledAt": "2023-06-15T10:00:00Z",
33            "state": "scheduled",
34            "stateChangedAt": "2023-06-14T15:30:00Z",
35            "subject": "Introducing our solution for {{prospect.company}}",
36            "trackLinks": true,
37            "trackOpens": true,
38            "unsubscribedAt": null,
39            "updatedAt": "2023-06-14T15:30:00Z"
40        },
41        "relationships": {
42            "mailbox": {
43                "data": {
44                    "type": "mailbox",
45                    "id": 1234
46                }
47            },
48            "opportunity": {
49                "data": null
50            },
51            "prospect": {
52                "data": {
53                    "type": "prospect",
54                    "id": 5678
55                }
56            },
57            "sequence": {
58                "data": {
59                    "type": "sequence",
60                    "id": 9101
61                }
62            },
63            "sequenceState": {
64                "data": {
65                    "type": "sequenceState",
66                    "id": 1516
67                }
68            },
69            "sequenceStep": {
70                "data": {
71                    "type": "sequenceStep",
72                    "id": 1718
73                }
74            },
75            "task": {
76                "data": null
77            },
78            "tasks": {
79                "data": [],
80                "links": {
81                    "related": "https://api.outreach.io/api/v2/mailings/3141/tasks"
82                },
83                "meta": {
84                    "count": 0
85                }
86            },
87            "template": {
88                "data": {
89                    "type": "template",
90                    "id": 1121
91                }
92            }
93        },
94        "links": {
95            "self": "https://api.outreach.io/api/v2/mailings/3141"
96        }
97    }
98}

Create opportunity
Copy

Create an opportunity in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "New Enterprise Software Deal",
4        "amount": 100000,
5        "close_date": "2023-12-31T23:59:59Z",
6        "description": "Potential sale of our enterprise software suite to ACME Corporation",
7        "external_created_at": "2023-06-15T10:30:00Z",
8        "next_step": "Schedule product demo",
9        "opportunity_type": "New Business",
10        "probability": 60,
11        "prospecting_rep_id": "12345",
12        "tags": [
13            "enterprise",
14            "software",
15            "high-value"
16        ],
17        "custom_fields": {
18            "custom_1": "ACME Corp",
19            "custom_2": "John Doe",
20            "custom_3": "Q4 2023"
21        }
22    }
23}

Sample Output

1{
2    "data": {
3        "type": "opportunity",
4        "id": 67890,
5        "attributes": {
6            "amount": 100000,
7            "closeDate": "2023-12-31T23:59:59Z",
8            "createdAt": "2023-06-15T14:22:33Z",
9            "currencyType": "USD",
10            "custom1": "ACME Corp",
11            "custom2": "John Doe",
12            "custom3": "Q4 2023",
13            "description": "Potential sale of our enterprise software suite to ACME Corporation",
14            "externalCreatedAt": "2023-06-15T10:30:00Z",
15            "name": "New Enterprise Software Deal",
16            "nextStep": "Schedule product demo",
17            "opportunityType": "New Business",
18            "probability": 60,
19            "prospectingRepId": "12345",
20            "tags": [
21                "enterprise",
22                "software",
23                "high-value"
24            ],
25            "touchedAt": "2023-06-15T14:22:33Z",
26            "updatedAt": "2023-06-15T14:22:33Z"
27        },
28        "relationships": {
29            "account": {
30                "data": {
31                    "type": "account",
32                    "id": 54321
33                }
34            },
35            "creator": {
36                "data": {
37                    "type": "user",
38                    "id": 98765
39                }
40            },
41            "opportunityStage": {
42                "data": {
43                    "type": "opportunityStage",
44                    "id": 2
45                }
46            },
47            "owner": {
48                "data": {
49                    "type": "user",
50                    "id": 11111
51                }
52            },
53            "prospects": {
54                "links": {
55                    "related": "https://api.outreach.io/api/v2/opportunities/67890/prospects"
56                }
57            }
58        },
59        "links": {
60            "self": "https://api.outreach.io/api/v2/opportunities/67890"
61        }
62    }
63}

Create opportunity prospect role
Copy

Create an opportunity prospect role in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "role": "Decision Maker",
4        "primary": true
5    },
6    "relationships": {
7        "opportunity": 12345,
8        "prospect": 67890
9    }
10}

Sample Output

1{
2    "data": {
3        "type": "opportunityProspectRole",
4        "id": 98765,
5        "attributes": {
6            "createdAt": "2023-05-15T14:30:00Z",
7            "primary": true,
8            "role": "Decision Maker",
9            "updatedAt": "2023-05-15T14:30:00Z"
10        },
11        "relationships": {
12            "opportunity": {
13                "data": {
14                    "type": "opportunity",
15                    "id": 12345
16                }
17            },
18            "prospect": {
19                "data": {
20                    "type": "prospect",
21                    "id": 67890
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/opportunityProspectRoles/98765"
27        }
28    }
29}

Create opportunity stage
Copy

Create an opportunity stage in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "Proposal Sent",
4        "color": "#4CAF50",
5        "order": 3
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "opportunityStage",
4        "id": 12345,
5        "attributes": {
6            "color": "#4CAF50",
7            "createdAt": "2023-05-15T14:30:00Z",
8            "name": "Proposal Sent",
9            "order": 3,
10            "updatedAt": "2023-05-15T14:30:00Z"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 67890
17                }
18            },
19            "opportunities": {
20                "links": {
21                    "related": "https://api.outreach.io/api/v2/opportunityStages/12345/opportunities"
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/opportunityStages/12345"
27        }
28    }
29}

Create prospect
Copy

Create a prospect in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "first_name": "John",
4        "last_name": "Doe",
5        "emails": [
6            "john.doe@example.com"
7        ],
8        "title": "Sales Manager",
9        "company": "Acme Corp",
10        "work_phones": [
11            "+1 (555) 123-4567"
12        ],
13        "mobile_phones": [
14            "+1 (555) 987-6543"
15        ],
16        "address_street": "123 Main St",
17        "address_city": "San Francisco",
18        "address_state": "CA",
19        "address_country": "USA",
20        "address_zip": "94105",
21        "time_zone": "America/Los_Angeles",
22        "linkedin_url": "https://www.linkedin.com/in/johndoe",
23        "twitter_username": "johndoe",
24        "tags": [
25            "sales",
26            "technology"
27        ],
28        "custom_fields": {
29            "custom_1": "VIP Client",
30            "custom_2": "Q3 2023 Target"
31        }
32    },
33    "relationships": {
34        "account": "12345",
35        "owner": "67890"
36    }
37}

Sample Output

1{
2    "data": {
3        "type": "prospect",
4        "id": 987654,
5        "attributes": {
6            "firstName": "John",
7            "lastName": "Doe",
8            "name": "John Doe",
9            "emails": [
10                "john.doe@example.com"
11            ],
12            "title": "Sales Manager",
13            "workPhones": [
14                "+1 (555) 123-4567"
15            ],
16            "mobilePhones": [
17                "+1 (555) 987-6543"
18            ],
19            "addressStreet": "123 Main St",
20            "addressCity": "San Francisco",
21            "addressState": "CA",
22            "addressCountry": "USA",
23            "addressZip": "94105",
24            "timeZone": "America/Los_Angeles",
25            "linkedInUrl": "https://www.linkedin.com/in/johndoe",
26            "twitterUsername": "johndoe",
27            "tags": [
28                "sales",
29                "technology"
30            ],
31            "custom1": "VIP Client",
32            "custom2": "Q3 2023 Target",
33            "createdAt": "2023-06-15T10:30:00Z",
34            "updatedAt": "2023-06-15T10:30:00Z"
35        },
36        "relationships": {
37            "account": {
38                "data": {
39                    "type": "account",
40                    "id": 12345
41                }
42            },
43            "owner": {
44                "data": {
45                    "type": "user",
46                    "id": 67890
47                }
48            }
49        },
50        "links": {
51            "self": "https://api.outreach.io/api/v2/prospects/987654"
52        }
53    }
54}

Create sequence
Copy

Create a sequence in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "New Customer Onboarding",
4        "sequence_type": "interval",
5        "share_type": "shared",
6        "schedule_interval_type": "calendar",
7        "description": "A sequence to welcome and onboard new customers",
8        "tags": [
9            "onboarding",
10            "welcome",
11            "new customer"
12        ],
13        "finish_on_reply": true,
14        "max_activations": 100,
15        "throttle_paused": false
16    },
17    "relationships": {
18        "owner": 12345,
19        "ruleset": 67890
20    }
21}

Sample Output

1{
2    "data": {
3        "type": "sequence",
4        "id": 98765,
5        "attributes": {
6            "bounceCount": 0,
7            "clickCount": 0,
8            "createdAt": "2023-06-15T10:30:00Z",
9            "deliverCount": 0,
10            "description": "A sequence to welcome and onboard new customers",
11            "enabled": true,
12            "enabledAt": "2023-06-15T10:30:00Z",
13            "failureCount": 0,
14            "finishOnReply": true,
15            "lastUsedAt": null,
16            "locked": false,
17            "lockedAt": null,
18            "maxActivations": 100,
19            "name": "New Customer Onboarding",
20            "negativeReplyCount": 0,
21            "neutralReplyCount": 0,
22            "openCount": 0,
23            "optOutCount": 0,
24            "positiveReplyCount": 0,
25            "replyCount": 0,
26            "scheduleCount": 0,
27            "scheduleIntervalType": "calendar",
28            "sequenceType": "interval",
29            "shareType": "shared",
30            "tags": [
31                "onboarding",
32                "welcome",
33                "new customer"
34            ],
35            "throttleMaxAddsPerDay": 50,
36            "throttlePaused": false,
37            "throttlePausedAt": null,
38            "updatedAt": "2023-06-15T10:30:00Z"
39        },
40        "relationships": {
41            "calls": {
42                "links": {
43                    "related": "https://api.outreach.io/api/v2/sequences/98765/calls"
44                }
45            },
46            "creator": {
47                "data": {
48                    "type": "user",
49                    "id": 12345
50                }
51            },
52            "mailings": {
53                "links": {
54                    "related": "https://api.outreach.io/api/v2/sequences/98765/mailings"
55                }
56            },
57            "owner": {
58                "data": {
59                    "type": "user",
60                    "id": 12345
61                }
62            },
63            "ruleset": {
64                "data": {
65                    "type": "ruleset",
66                    "id": 67890
67                }
68            },
69            "sequenceStates": {
70                "links": {
71                    "related": "https://api.outreach.io/api/v2/sequences/98765/sequenceStates"
72                }
73            },
74            "sequenceSteps": {
75                "data": [],
76                "links": {
77                    "related": "https://api.outreach.io/api/v2/sequences/98765/sequenceSteps"
78                },
79                "meta": {
80                    "count": 0
81                }
82            },
83            "tasks": {
84                "links": {
85                    "related": "https://api.outreach.io/api/v2/sequences/98765/tasks"
86                }
87            },
88            "updater": {
89                "data": {
90                    "type": "user",
91                    "id": 12345
92                }
93            }
94        },
95        "links": {
96            "self": "https://api.outreach.io/api/v2/sequences/98765"
97        }
98    }
99}

Create sequence state
Copy

Create a sequence state in your Outreach account.

Sample Input

1{
2    "relationships": {
3        "mailbox": 123,
4        "prospect": 456,
5        "sequence": 789
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "sequenceState",
4        "id": 1001,
5        "attributes": {
6            "activeAt": "2023-05-15T10:30:00Z",
7            "bounceCount": 0,
8            "callCompletedAt": null,
9            "clickCount": 2,
10            "createdAt": "2023-05-15T10:30:00Z",
11            "deliverCount": 1,
12            "errorReason": null,
13            "failureCount": 0,
14            "negativeReplyCount": 0,
15            "neutralReplyCount": 0,
16            "openCount": 3,
17            "optOutCount": 0,
18            "pauseReason": null,
19            "positiveReplyCount": 1,
20            "repliedAt": "2023-05-15T14:45:00Z",
21            "replyCount": 1,
22            "scheduleCount": 3,
23            "state": "active",
24            "stateChangedAt": "2023-05-15T10:30:00Z",
25            "updatedAt": "2023-05-15T14:45:00Z"
26        },
27        "relationships": {
28            "activeStepMailings": {
29                "data": [],
30                "links": {
31                    "related": "https://api.outreach.io/api/v2/sequenceStates/1001/activeStepMailings"
32                },
33                "meta": {
34                    "count": 0
35                }
36            },
37            "activeStepTasks": {
38                "data": [],
39                "links": {
40                    "related": "https://api.outreach.io/api/v2/sequenceStates/1001/activeStepTasks"
41                },
42                "meta": {
43                    "count": 0
44                }
45            },
46            "calls": {
47                "links": {
48                    "related": "https://api.outreach.io/api/v2/sequenceStates/1001/calls"
49                }
50            },
51            "creator": {
52                "data": {
53                    "type": "user",
54                    "id": 5001
55                }
56            },
57            "mailbox": {
58                "data": {
59                    "type": "mailbox",
60                    "id": 123
61                }
62            },
63            "mailings": {
64                "links": {
65                    "related": "https://api.outreach.io/api/v2/sequenceStates/1001/mailings"
66                }
67            },
68            "opportunity": {
69                "data": null
70            },
71            "prospect": {
72                "data": {
73                    "type": "prospect",
74                    "id": 456
75                }
76            },
77            "sequence": {
78                "data": {
79                    "type": "sequence",
80                    "id": 789
81                }
82            },
83            "sequenceStep": {
84                "data": {
85                    "type": "sequenceStep",
86                    "id": 2001
87                }
88            },
89            "tasks": {
90                "links": {
91                    "related": "https://api.outreach.io/api/v2/sequenceStates/1001/tasks"
92                }
93            }
94        },
95        "links": {
96            "self": "https://api.outreach.io/api/v2/sequenceStates/1001"
97        }
98    }
99}

Create stage
Copy

Create a stage in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "name": "Qualified Lead",
4        "color": "#4CAF50",
5        "order": 2
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "stage",
4        "id": 123,
5        "attributes": {
6            "color": "#4CAF50",
7            "createdAt": "2023-05-15T14:30:00Z",
8            "name": "Qualified Lead",
9            "order": 2,
10            "updatedAt": "2023-05-15T14:30:00Z"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 456
17                }
18            },
19            "prospects": {
20                "links": {
21                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
22                }
23            },
24            "updater": {
25                "data": {
26                    "type": "user",
27                    "id": 456
28                }
29            }
30        },
31        "links": {
32            "self": "https://api.outreach.io/api/v2/stages/123"
33        }
34    }
35}

Create task
Copy

Create a task in your Outreach account.

Sample Input

1{
2    "attributes": {
3        "action": "call",
4        "due_at": "2023-06-15T14:30:00Z",
5        "note": "Follow up with client regarding new product features"
6    },
7    "relationships": {
8        "subject": {
9            "type": "Account",
10            "id": 12345
11        },
12        "task_priority": 2,
13        "owner": 67890
14    }
15}

Sample Output

1{
2    "data": {
3        "type": "task",
4        "id": 98765,
5        "attributes": {
6            "action": "call",
7            "autoskipAt": null,
8            "compiledSequenceTemplateHtml": null,
9            "completed": false,
10            "completedAt": null,
11            "createdAt": "2023-06-10T09:15:30Z",
12            "dueAt": "2023-06-15T14:30:00Z",
13            "note": "Follow up with client regarding new product features",
14            "opportunityAssociation": null,
15            "scheduledAt": null,
16            "state": "incomplete",
17            "stateChangedAt": "2023-06-10T09:15:30Z",
18            "taskType": "manual",
19            "updatedAt": "2023-06-10T09:15:30Z"
20        },
21        "relationships": {
22            "account": {
23                "data": {
24                    "type": "account",
25                    "id": 12345
26                }
27            },
28            "owner": {
29                "data": {
30                    "type": "user",
31                    "id": 67890
32                }
33            },
34            "taskPriority": {
35                "data": {
36                    "type": "taskPriority",
37                    "id": 2
38                }
39            },
40            "subject": {
41                "data": {
42                    "type": "account",
43                    "id": 12345
44                }
45            }
46        },
47        "links": {
48            "self": "https://api.outreach.io/api/v2/tasks/98765"
49        }
50    }
51}

Delete account
Copy

Delete an account from your Outreach account, using their unique ID.

Sample Input

1{
2    "account_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete call
Copy

Deletes a call from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete call disposition
Copy

Delete an call disposition from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_disposition_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete call purpose
Copy

Delete an call purpose from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_purpose_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete opportunity
Copy

Delete an opportunity from your Outreach account, using their unique ID.

Sample Input

1{
2    "opportunity_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete opportunity prospect role
Copy

Delete an opportunity prospect role from your Outreach account, using their unique ID.

Sample Input

1{
2    "prospect_role_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete opportunity stage
Copy

Delete an opportunity stage from your Outreach account, using their unique ID.

Sample Input

1{
2    "opportunity_stage_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete prospect
Copy

Deletes a prospect from your Outreach account, using their unique ID.

Sample Input

1{
2    "prospect_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete sequence
Copy

Delete a sequence in your Outreach account, using their unique ID.

Sample Input

1{
2    "sequence_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete sequence state
Copy

Delete a sequence state in your Outreach account, using it's unique ID.

Sample Input

1{
2    "sequence_state_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Delete stage
Copy

Delete a stage in your Outreach account, using their unique ID.

Sample Input

1{
2    "stage_id": 123
3}

Sample Output

1{
2    "deleted": true
3}

Delete task
Copy

Delete a task from your Outreach account, using their unique ID.

Sample Input

1{
2    "task_id": 12345
3}

Sample Output

1{
2    "deleted": true
3}

Execute link
Copy

Execute a link provided by the Outreach API and return it's results. Note: only 'GET' requests will be performed.

Sample Input

1{
2    "link": "https://api.outreach.io/api/v2/prospects/123"
3}

Sample Output

1{
2    "data": {
3        "type": "prospect",
4        "id": 123,
5        "attributes": {
6            "firstName": "John",
7            "lastName": "Doe",
8            "email": "john.doe@example.com",
9            "title": "Sales Manager",
10            "company": "Acme Corp",
11            "createdAt": "2023-05-15T10:30:00Z",
12            "updatedAt": "2023-05-16T14:45:00Z"
13        },
14        "relationships": {
15            "account": {
16                "data": {
17                    "type": "account",
18                    "id": 456
19                }
20            },
21            "owner": {
22                "data": {
23                    "type": "user",
24                    "id": 789
25                }
26            }
27        }
28    }
29}

Get account
Copy

Gets an account from your Outreach account, using their unique ID.

Sample Input

1{
2    "account_id": "12345",
3    "fields": [
4        "name",
5        "domain",
6        "industry",
7        "numberOfEmployees",
8        "websiteUrl"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "account",
4        "id": 12345,
5        "attributes": {
6            "name": "Acme Corporation",
7            "domain": "acmecorp.com",
8            "industry": "Technology",
9            "numberOfEmployees": 500,
10            "websiteUrl": "https://www.acmecorp.com"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 1001
17                }
18            },
19            "owner": {
20                "data": {
21                    "type": "user",
22                    "id": 1002
23                }
24            },
25            "prospects": {
26                "links": {
27                    "related": "https://api.outreach.io/api/v2/accounts/12345/prospects"
28                }
29            },
30            "tasks": {
31                "links": {
32                    "related": "https://api.outreach.io/api/v2/accounts/12345/tasks"
33                }
34            },
35            "updater": {
36                "data": {
37                    "type": "user",
38                    "id": 1003
39                }
40            }
41        },
42        "links": {
43            "self": "https://api.outreach.io/api/v2/accounts/12345"
44        }
45    }
46}

Get call
Copy

Gets a call from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_id": "12345",
3    "fields": [
4        "answeredAt",
5        "direction",
6        "from",
7        "to",
8        "state",
9        "outcome"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "call",
4        "id": 12345,
5        "attributes": {
6            "answeredAt": "2023-05-15T14:30:00Z",
7            "direction": "outbound",
8            "from": "+14155551234",
9            "to": "+14155555678",
10            "state": "completed",
11            "outcome": "connected"
12        },
13        "relationships": {
14            "user": {
15                "data": {
16                    "type": "user",
17                    "id": 789
18                }
19            },
20            "prospect": {
21                "data": {
22                    "type": "prospect",
23                    "id": 456
24                }
25            }
26        },
27        "links": {
28            "self": "https://api.outreach.io/api/v2/calls/12345"
29        }
30    }
31}

Get call disposition
Copy

Gets a call disposition from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_disposition_id": 123,
3    "fields": [
4        "name",
5        "outcome",
6        "order"
7    ]
8}

Sample Output

1{
2    "data": {
3        "type": "callDisposition",
4        "id": 123,
5        "attributes": {
6            "name": "Successful Demo",
7            "outcome": "positive",
8            "order": 1
9        },
10        "relationships": {
11            "calls": {
12                "links": {
13                    "related": "https://api.outreach.io/api/v2/callDispositions/123/calls"
14                }
15            },
16            "creator": {
17                "data": {
18                    "type": "user",
19                    "id": 456
20                }
21            }
22        },
23        "links": {
24            "self": "https://api.outreach.io/api/v2/callDispositions/123"
25        }
26    }
27}

Get call purpose
Copy

Gets a call purpose from your Outreach account, using their unique ID.

Sample Input

1{
2    "call_purpose_id": 123,
3    "fields": [
4        "name",
5        "order",
6        "createdAt"
7    ]
8}

Sample Output

1{
2    "data": {
3        "type": "callPurpose",
4        "id": 123,
5        "attributes": {
6            "name": "Follow-up",
7            "order": 2,
8            "createdAt": "2023-05-15T10:30:00Z"
9        },
10        "relationships": {
11            "calls": {
12                "links": {
13                    "related": "https://api.outreach.io/api/v2/callPurposes/123/calls"
14                }
15            },
16            "creator": {
17                "data": {
18                    "type": "user",
19                    "id": 456
20                }
21            }
22        },
23        "links": {
24            "self": "https://api.outreach.io/api/v2/callPurposes/123"
25        }
26    }
27}

Get compliance request
Copy

Retrieve the details for a specific compliance request.

Sample Input

1{
2    "compliance_request_id": 12345,
3    "fields": [
4        "batchComplianceRequestUuid",
5        "createdAt",
6        "objectType",
7        "pii",
8        "requestType",
9        "state"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "complianceRequest",
4        "id": 12345,
5        "attributes": {
6            "batchComplianceRequestUuid": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
7            "createdAt": "2023-06-15T10:30:00Z",
8            "objectType": "prospect",
9            "pii": {
10                "email": "john.doe@example.com"
11            },
12            "requestType": "delete",
13            "state": "completed"
14        },
15        "relationships": {
16            "requester": {
17                "data": {
18                    "type": "user",
19                    "id": 67890
20                }
21            }
22        },
23        "links": {
24            "self": "https://api.outreach.io/api/v2/complianceRequests/12345"
25        }
26    }
27}

Get event
Copy

Gets an event from your Outreach account, using their unique ID.

Sample Input

1{
2    "event_id": 12345,
3    "fields": [
4        "createdAt",
5        "eventAt",
6        "name",
7        "requestCity",
8        "requestDevice"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "event",
4        "id": 12345,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "eventAt": "2023-05-15T10:29:55Z",
8            "name": "prospect_created",
9            "requestCity": "San Francisco",
10            "requestDevice": "desktop"
11        },
12        "links": {
13            "self": "https://api.outreach.io/api/v2/events/12345"
14        }
15    }
16}

Get mailbox
Copy

Gets a mailbox from your Outreach account, using its unique ID.

Sample Input

1{
2    "mailbox_id": 123,
3    "fields": [
4        "email",
5        "emailProvider",
6        "maxEmailsPerDay",
7        "sendMethod",
8        "smtpHost",
9        "smtpPort",
10        "smtpSsl"
11    ]
12}

Sample Output

1{
2    "data": {
3        "type": "mailbox",
4        "id": 123,
5        "attributes": {
6            "email": "sales@example.com",
7            "emailProvider": "Gmail",
8            "maxEmailsPerDay": 500,
9            "sendMethod": "smtp",
10            "smtpHost": "smtp.gmail.com",
11            "smtpPort": 587,
12            "smtpSsl": true
13        },
14        "relationships": {
15            "creator": {
16                "data": {
17                    "type": "user",
18                    "id": 456
19                }
20            },
21            "mailings": {
22                "links": {
23                    "related": "https://api.outreach.io/api/v2/mailboxes/123/mailings"
24                }
25            },
26            "updater": {
27                "data": {
28                    "type": "user",
29                    "id": 789
30                }
31            },
32            "user": {
33                "data": {
34                    "type": "user",
35                    "id": 101
36                }
37            }
38        },
39        "links": {
40            "self": "https://api.outreach.io/api/v2/mailboxes/123"
41        }
42    }
43}

Get mailing
Copy

Gets a mailing from your Outreach account, using its unique ID.

Sample Input

1{
2    "mailing_id": 12345,
3    "fields": [
4        "subject",
5        "bodyHtml",
6        "createdAt",
7        "state",
8        "openCount"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "mailing",
4        "id": 12345,
5        "attributes": {
6            "subject": "Important Update: New Product Launch",
7            "bodyHtml": "<html><body><h1>Exciting News!</h1><p>We're thrilled to announce our new product launch...</p></body></html>",
8            "createdAt": "2023-05-15T10:30:00Z",
9            "state": "delivered",
10            "openCount": 157
11        },
12        "relationships": {
13            "mailbox": {
14                "data": {
15                    "type": "mailbox",
16                    "id": 789
17                }
18            },
19            "prospect": {
20                "data": {
21                    "type": "prospect",
22                    "id": 456
23                }
24            },
25            "sequence": {
26                "data": {
27                    "type": "sequence",
28                    "id": 101
29                }
30            }
31        },
32        "links": {
33            "self": "https://api.outreach.io/api/v2/mailings/12345"
34        }
35    }
36}

Get opportunity
Copy

Gets an opportunity from your Outreach account, using their unique ID.

Sample Input

1{
2    "opportunity_id": "12345",
3    "fields": [
4        "amount",
5        "closeDate",
6        "name",
7        "description",
8        "probability"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "opportunity",
4        "id": 12345,
5        "attributes": {
6            "amount": 50000,
7            "closeDate": "2023-12-31",
8            "name": "Enterprise Software Deal",
9            "description": "Potential sale of our enterprise software suite to ACME Corporation",
10            "probability": 0.75
11        },
12        "relationships": {
13            "account": {
14                "data": {
15                    "type": "account",
16                    "id": 67890
17                }
18            },
19            "creator": {
20                "data": {
21                    "type": "user",
22                    "id": 1122
23                }
24            },
25            "opportunityStage": {
26                "data": {
27                    "type": "opportunityStage",
28                    "id": 3
29                }
30            },
31            "owner": {
32                "data": {
33                    "type": "user",
34                    "id": 3344
35                }
36            },
37            "prospects": {
38                "links": {
39                    "related": "https://api.outreach.io/api/v2/opportunities/12345/prospects"
40                }
41            }
42        },
43        "links": {
44            "self": "https://api.outreach.io/api/v2/opportunities/12345"
45        }
46    }
47}

Get opportunity prospect role
Copy

Gets an opportunity prospect role from your Outreach account, using their unique ID.

Sample Input

1{
2    "prospect_role_id": 12345,
3    "fields": [
4        "createdAt",
5        "primary",
6        "role"
7    ]
8}

Sample Output

1{
2    "data": {
3        "type": "opportunityProspectRole",
4        "id": 12345,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "primary": true,
8            "role": "Decision Maker"
9        },
10        "relationships": {
11            "opportunity": {
12                "data": {
13                    "type": "opportunity",
14                    "id": 67890
15                }
16            },
17            "prospect": {
18                "data": {
19                    "type": "prospect",
20                    "id": 54321
21                }
22            }
23        },
24        "links": {
25            "self": "https://api.outreach.io/api/v2/opportunityProspectRoles/12345"
26        }
27    }
28}

Get opportunity stage
Copy

Gets an opportunity stage from your Outreach account, using their unique ID.

Sample Input

1{
2    "opportunity_stage_id": 123,
3    "fields": [
4        "color",
5        "name",
6        "order"
7    ]
8}

Sample Output

1{
2    "data": {
3        "type": "opportunityStage",
4        "id": 123,
5        "attributes": {
6            "color": "#4CAF50",
7            "createdAt": "2023-05-15T10:30:00Z",
8            "name": "Qualified",
9            "order": 2,
10            "updatedAt": "2023-05-15T10:30:00Z"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 456
17                }
18            },
19            "opportunities": {
20                "links": {
21                    "related": "https://api.outreach.io/api/v2/opportunityStages/123/opportunities"
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/opportunityStages/123"
27        }
28    }
29}

Get phone number
Copy

Gets a phone number of a prospect from your Outreach account, using the phone number ID.

Sample Input

1{
2    "phone_number_id": "12345",
3    "include_prospect": true,
4    "fields": [
5        "countryCode",
6        "number",
7        "phoneType",
8        "status"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "phoneNumber",
4        "id": 12345,
5        "attributes": {
6            "countryCode": "+1",
7            "createdAt": "2023-05-15T10:30:00Z",
8            "number": "5551234567",
9            "order": 1,
10            "phoneType": "work",
11            "rawNumber": "+15551234567",
12            "status": "active",
13            "statusChangedAt": "2023-05-15T10:30:00Z",
14            "updatedAt": "2023-05-15T10:30:00Z"
15        },
16        "relationships": {
17            "prospect": {
18                "data": {
19                    "type": "prospect",
20                    "id": 67890
21                }
22            }
23        },
24        "links": {
25            "self": "https://api.outreach.io/api/v2/phoneNumbers/12345"
26        }
27    },
28    "included": [
29        {
30            "type": "prospect",
31            "id": 67890,
32            "attributes": {
33                "firstName": "John",
34                "lastName": "Doe",
35                "name": "John Doe",
36                "title": "Sales Manager",
37                "company": "Acme Corp",
38                "emails": [
39                    "john.doe@acmecorp.com"
40                ],
41                "workPhones": [
42                    "+15551234567"
43                ],
44                "createdAt": "2023-05-01T09:00:00Z",
45                "updatedAt": "2023-05-15T10:30:00Z"
46            },
47            "relationships": {
48                "account": {
49                    "data": {
50                        "type": "account",
51                        "id": 54321
52                    }
53                },
54                "owner": {
55                    "data": {
56                        "type": "user",
57                        "id": 98765
58                    }
59                }
60            },
61            "links": {
62                "self": "https://api.outreach.io/api/v2/prospects/67890"
63            }
64        }
65    ]
66}

Get prospect
Copy

Gets a prospect from your Outreach account, using their unique ID.

Sample Input

1{
2    "prospect_id": "12345",
3    "fields": [
4        "firstName",
5        "lastName",
6        "email",
7        "title",
8        "company",
9        "phone"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "prospect",
4        "id": 12345,
5        "attributes": {
6            "firstName": "John",
7            "lastName": "Doe",
8            "emails": [
9                "john.doe@example.com"
10            ],
11            "title": "Sales Manager",
12            "workPhones": [
13                "+1 (555) 123-4567"
14            ],
15            "name": "John Doe",
16            "createdAt": "2023-05-15T10:30:00Z",
17            "updatedAt": "2023-05-15T10:30:00Z"
18        },
19        "relationships": {
20            "account": {
21                "data": {
22                    "type": "account",
23                    "id": 67890
24                }
25            },
26            "owner": {
27                "data": {
28                    "type": "user",
29                    "id": 54321
30                }
31            }
32        },
33        "links": {
34            "self": "https://api.outreach.io/api/v2/prospects/12345"
35        }
36    }
37}

Get sequence
Copy

Gets a sequence from your Outreach account, using their unique ID.

Sample Input

1{
2    "sequence_id": 123456,
3    "fields": [
4        "name",
5        "description",
6        "enabled",
7        "createdAt",
8        "updatedAt",
9        "tags"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "sequence",
4        "id": 123456,
5        "attributes": {
6            "name": "Welcome Sequence",
7            "description": "A sequence to welcome new customers",
8            "enabled": true,
9            "createdAt": "2023-05-15T10:30:00Z",
10            "updatedAt": "2023-05-20T14:45:00Z",
11            "tags": [
12                "welcome",
13                "onboarding",
14                "new-customer"
15            ]
16        },
17        "relationships": {
18            "creator": {
19                "data": {
20                    "type": "user",
21                    "id": 789
22                }
23            },
24            "owner": {
25                "data": {
26                    "type": "user",
27                    "id": 789
28                }
29            },
30            "sequenceSteps": {
31                "data": [],
32                "links": {
33                    "related": "https://api.outreach.io/api/v2/sequences/123456/sequenceSteps"
34                },
35                "meta": {
36                    "count": 3
37                }
38            }
39        },
40        "links": {
41            "self": "https://api.outreach.io/api/v2/sequences/123456"
42        }
43    }
44}

Get sequence state
Copy

Gets a sequence state from your Outreach account, using the sequence state ID.

Sample Input

1{
2    "sequence_state_id": 12345,
3    "fields": [
4        "state",
5        "createdAt",
6        "updatedAt",
7        "replyCount",
8        "openCount",
9        "clickCount"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "sequenceState",
4        "id": 12345,
5        "attributes": {
6            "state": "active",
7            "createdAt": "2023-05-15T10:30:00Z",
8            "updatedAt": "2023-05-16T14:45:00Z",
9            "replyCount": 3,
10            "openCount": 15,
11            "clickCount": 7
12        },
13        "relationships": {
14            "sequence": {
15                "data": {
16                    "type": "sequence",
17                    "id": 67890
18                }
19            },
20            "prospect": {
21                "data": {
22                    "type": "prospect",
23                    "id": 54321
24                }
25            },
26            "creator": {
27                "data": {
28                    "type": "user",
29                    "id": 98765
30                }
31            }
32        },
33        "links": {
34            "self": "https://api.outreach.io/api/v2/sequenceStates/12345"
35        }
36    }
37}

Get sequence step
Copy

Gets a sequence step from your Outreach account, using their unique ID.

Sample Input

1{
2    "sequence_step_id": 12345,
3    "fields": [
4        "displayName",
5        "stepType",
6        "order",
7        "interval",
8        "createdAt",
9        "updatedAt"
10    ]
11}

Sample Output

1{
2    "data": {
3        "type": "sequenceStep",
4        "id": 12345,
5        "attributes": {
6            "displayName": "Follow-up Email",
7            "stepType": "email",
8            "order": 2,
9            "interval": 3,
10            "createdAt": "2023-05-15T10:30:00Z",
11            "updatedAt": "2023-05-16T14:45:00Z"
12        },
13        "relationships": {
14            "sequence": {
15                "data": {
16                    "type": "sequence",
17                    "id": 789
18                }
19            },
20            "creator": {
21                "data": {
22                    "type": "user",
23                    "id": 101
24                }
25            },
26            "updater": {
27                "data": {
28                    "type": "user",
29                    "id": 102
30                }
31            },
32            "sequenceTemplates": {
33                "data": [
34                    {
35                        "type": "sequenceTemplate",
36                        "id": 456
37                    }
38                ],
39                "links": {
40                    "related": "https://api.outreach.io/api/v2/sequenceSteps/12345/sequenceTemplates"
41                },
42                "meta": {
43                    "count": 1
44                }
45            }
46        },
47        "links": {
48            "self": "https://api.outreach.io/api/v2/sequenceSteps/12345"
49        }
50    }
51}

Get stage
Copy

Gets a stage from your Outreach account, using their unique ID.

Sample Input

1{
2    "stage_id": 123,
3    "fields": [
4        "name",
5        "color",
6        "order"
7    ]
8}

Sample Output

1{
2    "data": {
3        "type": "stage",
4        "id": 123,
5        "attributes": {
6            "name": "Qualified",
7            "color": "#4CAF50",
8            "order": 2
9        },
10        "relationships": {
11            "creator": {
12                "data": {
13                    "type": "user",
14                    "id": 456
15                }
16            },
17            "prospects": {
18                "links": {
19                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
20                }
21            },
22            "updater": {
23                "data": {
24                    "type": "user",
25                    "id": 789
26                }
27            }
28        },
29        "links": {
30            "self": "https://api.outreach.io/api/v2/stages/123"
31        }
32    }
33}

Get task
Copy

Gets a task from your Outreach account, using their unique ID.

Sample Input

1{
2    "task_id": 12345,
3    "fields": [
4        "action",
5        "completed",
6        "dueAt",
7        "note",
8        "state"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "task",
4        "id": 12345,
5        "attributes": {
6            "action": "Call",
7            "completed": false,
8            "dueAt": "2023-05-15T14:30:00Z",
9            "note": "Follow up on product demo",
10            "state": "pending"
11        },
12        "relationships": {
13            "owner": {
14                "data": {
15                    "type": "user",
16                    "id": 67890
17                }
18            },
19            "prospect": {
20                "data": {
21                    "type": "prospect",
22                    "id": 54321
23                }
24            },
25            "taskPriority": {
26                "data": {
27                    "type": "taskPriority",
28                    "id": 2
29                }
30            }
31        },
32        "links": {
33            "self": "https://api.outreach.io/api/v2/tasks/12345"
34        }
35    }
36}

Get user
Copy

Gets a user from your Outreach account, using its unique ID.

Sample Input

1{
2    "user_id": 12345,
3    "fields": [
4        "firstName",
5        "lastName",
6        "email",
7        "title",
8        "phoneNumber"
9    ]
10}

Sample Output

1{
2    "data": {
3        "type": "user",
4        "id": 12345,
5        "attributes": {
6            "firstName": "John",
7            "lastName": "Doe",
8            "email": "john.doe@example.com",
9            "title": "Sales Representative",
10            "phoneNumber": "+1 (555) 123-4567"
11        },
12        "relationships": {
13            "calendar": {
14                "data": null
15            },
16            "creator": {
17                "data": {
18                    "type": "user",
19                    "id": 1
20                }
21            },
22            "mailbox": {
23                "data": {
24                    "type": "mailbox",
25                    "id": 789
26                }
27            },
28            "teams": {
29                "data": [],
30                "links": {
31                    "related": "https://api.outreach.io/api/v2/users/12345/teams"
32                },
33                "meta": {
34                    "count": 0
35                }
36            },
37            "updater": {
38                "data": {
39                    "type": "user",
40                    "id": 1
41                }
42            }
43        },
44        "links": {
45            "self": "https://api.outreach.io/api/v2/users/12345"
46        }
47    }
48}

List accounts
Copy

Get a list of accounts in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "industry",
5            "criteria": "Technology"
6        },
7        {
8            "field": "numberOfEmployees",
9            "criteria": {
10                "from": "100",
11                "to": "1000"
12            }
13        }
14    ],
15    "sort": {
16        "sort_by": "name",
17        "sort_direction": "asc"
18    },
19    "page_size": 25,
20    "fields": [
21        "name",
22        "industry",
23        "numberOfEmployees",
24        "websiteUrl"
25    ]
26}

Sample Output

1{
2    "data": [
3        {
4            "type": "account",
5            "id": 1234,
6            "attributes": {
7                "name": "Acme Tech Solutions",
8                "industry": "Technology",
9                "numberOfEmployees": 500,
10                "websiteUrl": "https://www.acmetechsolutions.com"
11            },
12            "relationships": {
13                "assignedTeams": {
14                    "data": [],
15                    "links": {
16                        "related": "https://api.outreach.io/api/v2/accounts/1234/assignedTeams"
17                    },
18                    "meta": {
19                        "count": 0
20                    }
21                },
22                "assignedUsers": {
23                    "data": [],
24                    "links": {
25                        "related": "https://api.outreach.io/api/v2/accounts/1234/assignedUsers"
26                    },
27                    "meta": {
28                        "count": 0
29                    }
30                }
31            },
32            "links": {
33                "self": "https://api.outreach.io/api/v2/accounts/1234"
34            }
35        },
36        {
37            "type": "account",
38            "id": 5678,
39            "attributes": {
40                "name": "Beta Software Inc",
41                "industry": "Technology",
42                "numberOfEmployees": 750,
43                "websiteUrl": "https://www.betasoftware.com"
44            },
45            "relationships": {
46                "assignedTeams": {
47                    "data": [],
48                    "links": {
49                        "related": "https://api.outreach.io/api/v2/accounts/5678/assignedTeams"
50                    },
51                    "meta": {
52                        "count": 0
53                    }
54                },
55                "assignedUsers": {
56                    "data": [],
57                    "links": {
58                        "related": "https://api.outreach.io/api/v2/accounts/5678/assignedUsers"
59                    },
60                    "meta": {
61                        "count": 0
62                    }
63                }
64            },
65            "links": {
66                "self": "https://api.outreach.io/api/v2/accounts/5678"
67            }
68        }
69    ],
70    "meta": {
71        "count": 2
72    },
73    "links": {
74        "first": "https://api.outreach.io/api/v2/accounts?page[limit]=25&page[offset]=0",
75        "next": null
76    }
77}

List audits
Copy

Retrieve a list of events that happen during the day.

Sample Input

1{
2    "filters": [
3        {
4            "field": "eventName",
5            "criteria": "login"
6        },
7        {
8            "field": "timestamp",
9            "criteria": {
10                "from": "2023-05-01T00:00:00Z",
11                "to": "2023-05-31T23:59:59Z"
12            }
13        }
14    ],
15    "sort": {
16        "sort_by": "timestamp",
17        "sort_direction": "desc"
18    },
19    "page_size": 50
20}

Sample Output

1{
2    "links": {
3        "first": "https://api.outreach.io/api/v2/audits?page[size]=50&sort=-timestamp",
4        "prev": null
5    },
6    "data": [
7        {
8            "id": "12345",
9            "type": "audit",
10            "attributes": {
11                "user": "john.doe@example.com",
12                "userId": 67890,
13                "requestIp": "192.168.1.100",
14                "timestamp": "2023-05-31T15:45:30Z",
15                "eventName": "login",
16                "orgId": "org_123456"
17            }
18        },
19        {
20            "id": "12346",
21            "type": "audit",
22            "attributes": {
23                "user": "jane.smith@example.com",
24                "userId": 67891,
25                "requestIp": "192.168.1.101",
26                "timestamp": "2023-05-31T14:30:15Z",
27                "eventName": "login",
28                "orgId": "org_123456"
29            }
30        }
31    ],
32    "meta": {
33        "count": 2
34    }
35}

List call dispositions
Copy

List all call dispositions in your account

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "outcome",
6            "criteria": "positive"
7        }
8    ],
9    "sort": {
10        "sort_by": "name",
11        "sort_direction": "asc"
12    },
13    "fields": [
14        "name",
15        "outcome",
16        "order"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "callDisposition",
5            "id": 1,
6            "attributes": {
7                "name": "Appointment Set",
8                "order": 1,
9                "outcome": "positive"
10            },
11            "relationships": {
12                "calls": {
13                    "links": {
14                        "related": "https://api.outreach.io/api/v2/callDispositions/1/calls"
15                    }
16                },
17                "creator": {
18                    "data": {
19                        "type": "user",
20                        "id": 101
21                    }
22                }
23            },
24            "links": {
25                "self": "https://api.outreach.io/api/v2/callDispositions/1"
26            }
27        },
28        {
29            "type": "callDisposition",
30            "id": 2,
31            "attributes": {
32                "name": "Demo Scheduled",
33                "order": 2,
34                "outcome": "positive"
35            },
36            "relationships": {
37                "calls": {
38                    "links": {
39                        "related": "https://api.outreach.io/api/v2/callDispositions/2/calls"
40                    }
41                },
42                "creator": {
43                    "data": {
44                        "type": "user",
45                        "id": 102
46                    }
47                }
48            },
49            "links": {
50                "self": "https://api.outreach.io/api/v2/callDispositions/2"
51            }
52        }
53    ],
54    "meta": {
55        "count": 2
56    }
57}

List call purposes
Copy

List all call purposes in your account

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "Follow-up"
7        }
8    ],
9    "sort": {
10        "sort_by": "order",
11        "sort_direction": "asc"
12    },
13    "fields": [
14        "name",
15        "order",
16        "createdAt"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "callPurpose",
5            "id": 1,
6            "attributes": {
7                "name": "Follow-up",
8                "order": 1,
9                "createdAt": "2023-05-01T10:00:00Z"
10            },
11            "relationships": {
12                "calls": {
13                    "links": {
14                        "related": "https://api.outreach.io/api/v2/calls?filter[purpose]=1"
15                    }
16                },
17                "creator": {
18                    "data": {
19                        "type": "user",
20                        "id": 101
21                    }
22                }
23            },
24            "links": {
25                "self": "https://api.outreach.io/api/v2/callPurposes/1"
26            }
27        },
28        {
29            "type": "callPurpose",
30            "id": 2,
31            "attributes": {
32                "name": "Introduction",
33                "order": 2,
34                "createdAt": "2023-05-02T09:30:00Z"
35            },
36            "relationships": {
37                "calls": {
38                    "links": {
39                        "related": "https://api.outreach.io/api/v2/calls?filter[purpose]=2"
40                    }
41                },
42                "creator": {
43                    "data": {
44                        "type": "user",
45                        "id": 102
46                    }
47                }
48            },
49            "links": {
50                "self": "https://api.outreach.io/api/v2/callPurposes/2"
51            }
52        }
53    ],
54    "meta": {
55        "count": 2
56    }
57}

List compliance requests
Copy

Retrieve a list of regulatory requests to delete or export personal information.

Sample Input

1{
2    "filters": [
3        {
4            "field": "requestType",
5            "criteria": "export"
6        },
7        {
8            "field": "state",
9            "criteria": [
10                "pending",
11                "in_progress"
12            ]
13        }
14    ],
15    "sort": {
16        "sort_by": "createdAt",
17        "sort_direction": "desc"
18    },
19    "page_size": 50,
20    "fields": [
21        "uuid",
22        "requestType",
23        "state",
24        "createdAt",
25        "pii"
26    ]
27}

Sample Output

1{
2    "data": [
3        {
4            "type": "complianceRequest",
5            "id": 12345,
6            "attributes": {
7                "uuid": "abc123-def456-ghi789",
8                "requestType": "export",
9                "state": "pending",
10                "createdAt": "2023-05-15T10:30:00Z",
11                "pii": {
12                    "email": "john.doe@example.com"
13                }
14            },
15            "relationships": {
16                "requester": {
17                    "data": {
18                        "type": "user",
19                        "id": 67890
20                    }
21                }
22            },
23            "links": {
24                "self": "https://api.outreach.io/api/v2/complianceRequests/12345"
25            }
26        },
27        {
28            "type": "complianceRequest",
29            "id": 12346,
30            "attributes": {
31                "uuid": "jkl012-mno345-pqr678",
32                "requestType": "export",
33                "state": "in_progress",
34                "createdAt": "2023-05-14T15:45:00Z",
35                "pii": {
36                    "email": "jane.smith@example.com"
37                }
38            },
39            "relationships": {
40                "requester": {
41                    "data": {
42                        "type": "user",
43                        "id": 67891
44                    }
45                }
46            },
47            "links": {
48                "self": "https://api.outreach.io/api/v2/complianceRequests/12346"
49            }
50        }
51    ],
52    "meta": {
53        "count": 2
54    },
55    "links": {
56        "next": "https://api.outreach.io/api/v2/complianceRequests?page[after]=12346"
57    }
58}

List events
Copy

Get a list of events in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "name",
5            "criteria": "email_opened"
6        },
7        {
8            "field": "eventAt",
9            "criteria": {
10                "from": "2023-05-01T00:00:00Z",
11                "to": "2023-05-31T23:59:59Z"
12            }
13        }
14    ],
15    "sort": {
16        "sort_by": "eventAt",
17        "sort_direction": "desc"
18    },
19    "page_size": 50,
20    "fields": [
21        "createdAt",
22        "eventAt",
23        "name",
24        "requestCity",
25        "requestDevice"
26    ]
27}

Sample Output

1{
2    "data": [
3        {
4            "type": "event",
5            "id": 12345,
6            "attributes": {
7                "createdAt": "2023-05-31T15:45:22Z",
8                "eventAt": "2023-05-31T15:45:20Z",
9                "name": "email_opened",
10                "requestCity": "New York",
11                "requestDevice": "iPhone"
12            },
13            "links": {
14                "self": "https://api.outreach.io/api/v2/events/12345"
15            }
16        },
17        {
18            "type": "event",
19            "id": 12344,
20            "attributes": {
21                "createdAt": "2023-05-30T09:12:05Z",
22                "eventAt": "2023-05-30T09:12:03Z",
23                "name": "email_opened",
24                "requestCity": "San Francisco",
25                "requestDevice": "Chrome"
26            },
27            "links": {
28                "self": "https://api.outreach.io/api/v2/events/12344"
29            }
30        }
31    ],
32    "links": {
33        "last": "https://api.outreach.io/api/v2/events?page[number]=10&page[size]=50",
34        "next": "https://api.outreach.io/api/v2/events?page[number]=2&page[size]=50"
35    },
36    "meta": {
37        "count": 487
38    }
39}

List mail aliases
Copy

Get a list of alternative email names for a mailboxes in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "email",
5            "criteria": "@outreach.io"
6        }
7    ],
8    "sort": {
9        "sort_by": "createdAt",
10        "sort_direction": "desc"
11    },
12    "page_size": 25,
13    "fields": [
14        "email",
15        "canSend",
16        "createdAt"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "mailAlias",
5            "id": 12345,
6            "attributes": {
7                "canSend": true,
8                "createdAt": "2023-05-15T14:30:00Z",
9                "email": "sales@outreach.io"
10            },
11            "relationships": {
12                "mailbox": {
13                    "data": {
14                        "type": "mailbox",
15                        "id": 67890
16                    }
17                }
18            },
19            "links": {
20                "self": "https://api.outreach.io/api/v2/mailAliases/12345"
21            }
22        },
23        {
24            "type": "mailAlias",
25            "id": 12346,
26            "attributes": {
27                "canSend": true,
28                "createdAt": "2023-05-14T09:15:00Z",
29                "email": "support@outreach.io"
30            },
31            "relationships": {
32                "mailbox": {
33                    "data": {
34                        "type": "mailbox",
35                        "id": 67891
36                    }
37                }
38            },
39            "links": {
40                "self": "https://api.outreach.io/api/v2/mailAliases/12346"
41            }
42        }
43    ],
44    "meta": {
45        "count": 2
46    }
47}

List mailboxes
Copy

Get a list of mailboxes in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "fields": [
4        "email",
5        "emailProvider",
6        "createdAt",
7        "updatedAt"
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "filters": [
14        {
15            "field": "emailProvider",
16            "criteria": "Gmail"
17        }
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "mailbox",
5            "id": 1234,
6            "attributes": {
7                "email": "sales@example.com",
8                "emailProvider": "Gmail",
9                "createdAt": "2023-06-15T10:30:00Z",
10                "updatedAt": "2023-06-15T10:30:00Z"
11            },
12            "relationships": {
13                "creator": {
14                    "data": {
15                        "type": "user",
16                        "id": 5678
17                    }
18                },
19                "user": {
20                    "data": {
21                        "type": "user",
22                        "id": 5678
23                    }
24                }
25            },
26            "links": {
27                "self": "https://api.outreach.io/api/v2/mailboxes/1234"
28            }
29        },
30        {
31            "type": "mailbox",
32            "id": 1235,
33            "attributes": {
34                "email": "support@example.com",
35                "emailProvider": "Gmail",
36                "createdAt": "2023-06-14T09:15:00Z",
37                "updatedAt": "2023-06-14T09:15:00Z"
38            },
39            "relationships": {
40                "creator": {
41                    "data": {
42                        "type": "user",
43                        "id": 5679
44                    }
45                },
46                "user": {
47                    "data": {
48                        "type": "user",
49                        "id": 5679
50                    }
51                }
52            },
53            "links": {
54                "self": "https://api.outreach.io/api/v2/mailboxes/1235"
55            }
56        }
57    ],
58    "meta": {
59        "count": 2
60    }
61}

List mailings
Copy

Get a list of mailings in your Outreach account.

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "mailingType",
6            "criteria": "sequence"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "subject",
15        "createdAt",
16        "state",
17        "mailingType",
18        "openCount",
19        "clickCount"
20    ]
21}

Sample Output

1{
2    "data": [
3        {
4            "type": "mailing",
5            "id": 12345,
6            "attributes": {
7                "subject": "Follow-up on our recent conversation",
8                "createdAt": "2023-06-15T10:30:00Z",
9                "state": "delivered",
10                "mailingType": "sequence",
11                "openCount": 3,
12                "clickCount": 1
13            },
14            "relationships": {
15                "prospect": {
16                    "data": {
17                        "type": "prospect",
18                        "id": 67890
19                    }
20                },
21                "sequence": {
22                    "data": {
23                        "type": "sequence",
24                        "id": 54321
25                    }
26                }
27            },
28            "links": {
29                "self": "https://api.outreach.io/api/v2/mailings/12345"
30            }
31        },
32        {
33            "type": "mailing",
34            "id": 12346,
35            "attributes": {
36                "subject": "Exclusive offer for you",
37                "createdAt": "2023-06-14T15:45:00Z",
38                "state": "opened",
39                "mailingType": "sequence",
40                "openCount": 2,
41                "clickCount": 0
42            },
43            "relationships": {
44                "prospect": {
45                    "data": {
46                        "type": "prospect",
47                        "id": 67891
48                    }
49                },
50                "sequence": {
51                    "data": {
52                        "type": "sequence",
53                        "id": 54321
54                    }
55                }
56            },
57            "links": {
58                "self": "https://api.outreach.io/api/v2/mailings/12346"
59            }
60        }
61    ],
62    "meta": {
63        "count": 2
64    }
65}

List opportunities
Copy

Get a list of opportunities in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "amount",
5            "criteria": {
6                "from": "10000",
7                "to": "50000"
8            }
9        },
10        {
11            "field": "closeDate",
12            "criteria": {
13                "from": "2023-01-01",
14                "to": "2023-12-31"
15            }
16        }
17    ],
18    "sort": {
19        "sort_by": "createdAt",
20        "sort_direction": "desc"
21    },
22    "page_size": 25,
23    "fields": [
24        "name",
25        "amount",
26        "closeDate",
27        "probability",
28        "opportunityType"
29    ]
30}

Sample Output

1{
2    "data": [
3        {
4            "type": "opportunity",
5            "id": 12345,
6            "attributes": {
7                "name": "Enterprise Software Deal",
8                "amount": 35000,
9                "closeDate": "2023-09-30",
10                "probability": 0.75,
11                "opportunityType": "new_business"
12            },
13            "relationships": {
14                "account": {
15                    "data": {
16                        "type": "account",
17                        "id": 67890
18                    }
19                },
20                "owner": {
21                    "data": {
22                        "type": "user",
23                        "id": 11111
24                    }
25                }
26            },
27            "links": {
28                "self": "https://api.outreach.io/api/v2/opportunities/12345"
29            }
30        },
31        {
32            "type": "opportunity",
33            "id": 12346,
34            "attributes": {
35                "name": "Expansion Deal",
36                "amount": 25000,
37                "closeDate": "2023-11-15",
38                "probability": 0.6,
39                "opportunityType": "expansion"
40            },
41            "relationships": {
42                "account": {
43                    "data": {
44                        "type": "account",
45                        "id": 67891
46                    }
47                },
48                "owner": {
49                    "data": {
50                        "type": "user",
51                        "id": 11112
52                    }
53                }
54            },
55            "links": {
56                "self": "https://api.outreach.io/api/v2/opportunities/12346"
57            }
58        }
59    ],
60    "meta": {
61        "count": 2
62    }
63}

List opportunity prospect roles
Copy

Get a list of opportunity prospect roles in your Outreach account

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "role",
6            "criteria": "Decision Maker"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "createdAt",
15        "primary",
16        "role",
17        "updatedAt"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "opportunityProspectRole",
5            "id": 12345,
6            "attributes": {
7                "createdAt": "2023-05-15T10:30:00Z",
8                "primary": true,
9                "role": "Decision Maker",
10                "updatedAt": "2023-05-15T10:30:00Z"
11            },
12            "relationships": {
13                "opportunity": {
14                    "data": {
15                        "type": "opportunity",
16                        "id": 67890
17                    }
18                },
19                "prospect": {
20                    "data": {
21                        "type": "prospect",
22                        "id": 54321
23                    }
24                }
25            },
26            "links": {
27                "self": "https://api.outreach.io/api/v2/opportunityProspectRoles/12345"
28            }
29        },
30        {
31            "type": "opportunityProspectRole",
32            "id": 12346,
33            "attributes": {
34                "createdAt": "2023-05-14T15:45:00Z",
35                "primary": false,
36                "role": "Influencer",
37                "updatedAt": "2023-05-14T15:45:00Z"
38            },
39            "relationships": {
40                "opportunity": {
41                    "data": {
42                        "type": "opportunity",
43                        "id": 67891
44                    }
45                },
46                "prospect": {
47                    "data": {
48                        "type": "prospect",
49                        "id": 54322
50                    }
51                }
52            },
53            "links": {
54                "self": "https://api.outreach.io/api/v2/opportunityProspectRoles/12346"
55            }
56        }
57    ],
58    "meta": {
59        "count": 2
60    }
61}

List opportunity stages
Copy

Get a list of opportunity stages in your Outreach account.

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "Qualified"
7        }
8    ],
9    "sort": {
10        "sort_by": "order",
11        "sort_direction": "asc"
12    },
13    "fields": [
14        "name",
15        "order",
16        "color"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "opportunityStage",
5            "id": 1,
6            "attributes": {
7                "name": "Qualified",
8                "order": 1,
9                "color": "#4CAF50"
10            },
11            "relationships": {
12                "creator": {
13                    "data": {
14                        "type": "user",
15                        "id": 101
16                    }
17                },
18                "opportunities": {
19                    "links": {
20                        "related": "https://api.outreach.io/api/v2/opportunityStages/1/opportunities"
21                    }
22                }
23            },
24            "links": {
25                "self": "https://api.outreach.io/api/v2/opportunityStages/1"
26            }
27        },
28        {
29            "type": "opportunityStage",
30            "id": 2,
31            "attributes": {
32                "name": "Discovery",
33                "order": 2,
34                "color": "#2196F3"
35            },
36            "relationships": {
37                "creator": {
38                    "data": {
39                        "type": "user",
40                        "id": 102
41                    }
42                },
43                "opportunities": {
44                    "links": {
45                        "related": "https://api.outreach.io/api/v2/opportunityStages/2/opportunities"
46                    }
47                }
48            },
49            "links": {
50                "self": "https://api.outreach.io/api/v2/opportunityStages/2"
51            }
52        }
53    ],
54    "meta": {
55        "count": 2
56    }
57}

List phone numbers
Copy

Get a list of phone numbers of prospects in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "phoneType",
5            "criteria": "mobile"
6        },
7        {
8            "field": "status",
9            "criteria": "active"
10        }
11    ],
12    "sort": {
13        "sort_by": "createdAt",
14        "sort_direction": "desc"
15    },
16    "page_size": 50,
17    "fields": [
18        "countryCode",
19        "number",
20        "phoneType",
21        "status"
22    ]
23}

Sample Output

1{
2    "data": [
3        {
4            "type": "phoneNumber",
5            "id": 12345,
6            "attributes": {
7                "countryCode": "+1",
8                "number": "5551234567",
9                "phoneType": "mobile",
10                "status": "active"
11            },
12            "relationships": {
13                "prospect": {
14                    "data": {
15                        "type": "prospect",
16                        "id": 67890
17                    }
18                }
19            },
20            "links": {
21                "self": "https://api.outreach.io/api/v2/phoneNumbers/12345"
22            }
23        },
24        {
25            "type": "phoneNumber",
26            "id": 12346,
27            "attributes": {
28                "countryCode": "+44",
29                "number": "7911123456",
30                "phoneType": "mobile",
31                "status": "active"
32            },
33            "relationships": {
34                "prospect": {
35                    "data": {
36                        "type": "prospect",
37                        "id": 67891
38                    }
39                }
40            },
41            "links": {
42                "self": "https://api.outreach.io/api/v2/phoneNumbers/12346"
43            }
44        }
45    ],
46    "meta": {
47        "count": 2
48    }
49}

List prospects
Copy

Get a list of recent prospects in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "filters": [
4        {
5            "field": "company",
6            "criteria": "Acme Inc"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "firstName",
15        "lastName",
16        "company",
17        "title",
18        "emails"
19    ]
20}

Sample Output

1{
2    "data": [
3        {
4            "type": "prospect",
5            "id": 12345,
6            "attributes": {
7                "firstName": "John",
8                "lastName": "Doe",
9                "company": "Acme Inc",
10                "title": "Sales Manager",
11                "emails": [
12                    "john.doe@acmeinc.com"
13                ]
14            },
15            "relationships": {
16                "account": {
17                    "data": {
18                        "type": "account",
19                        "id": 67890
20                    }
21                }
22            },
23            "links": {
24                "self": "https://api.outreach.io/api/v2/prospects/12345"
25            }
26        },
27        {
28            "type": "prospect",
29            "id": 12346,
30            "attributes": {
31                "firstName": "Jane",
32                "lastName": "Smith",
33                "company": "Acme Inc",
34                "title": "Marketing Director",
35                "emails": [
36                    "jane.smith@acmeinc.com"
37                ]
38            },
39            "relationships": {
40                "account": {
41                    "data": {
42                        "type": "account",
43                        "id": 67890
44                    }
45                }
46            },
47            "links": {
48                "self": "https://api.outreach.io/api/v2/prospects/12346"
49            }
50        }
51    ],
52    "meta": {
53        "count": 2
54    },
55    "links": {
56        "next": "https://api.outreach.io/api/v2/prospects?page[after]=12346"
57    }
58}

List recipients
Copy

Get a list of recipients in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "recipientType",
5            "criteria": "email"
6        }
7    ],
8    "sort": {
9        "sort_by": "createdAt",
10        "sort_direction": "desc"
11    },
12    "page_size": 50,
13    "fields": [
14        "createdAt",
15        "emailHash",
16        "recipientType",
17        "value"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "recipient",
5            "id": 12345,
6            "attributes": {
7                "createdAt": "2023-05-15T10:30:00Z",
8                "emailHash": "a1b2c3d4e5f6g7h8i9j0",
9                "recipientType": "email",
10                "value": "john.doe@example.com"
11            },
12            "links": {
13                "self": "https://api.outreach.io/api/v2/recipients/12345"
14            }
15        },
16        {
17            "type": "recipient",
18            "id": 12346,
19            "attributes": {
20                "createdAt": "2023-05-14T15:45:00Z",
21                "emailHash": "k1l2m3n4o5p6q7r8s9t0",
22                "recipientType": "email",
23                "value": "jane.smith@example.com"
24            },
25            "links": {
26                "self": "https://api.outreach.io/api/v2/recipients/12346"
27            }
28        }
29    ],
30    "meta": {
31        "count": 2
32    },
33    "links": {
34        "first": "https://api.outreach.io/api/v2/recipients?page[limit]=50&sort=-createdAt"
35    }
36}

List sequence states
Copy

Get a list of sequence states in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "filters": [
4        {
5            "field": "state",
6            "criteria": "active"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "state",
15        "createdAt",
16        "updatedAt",
17        "activeAt"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "sequenceState",
5            "id": 12345,
6            "attributes": {
7                "state": "active",
8                "createdAt": "2023-05-15T10:30:00Z",
9                "updatedAt": "2023-05-15T10:30:00Z",
10                "activeAt": "2023-05-15T10:30:00Z"
11            },
12            "relationships": {
13                "sequence": {
14                    "data": {
15                        "type": "sequence",
16                        "id": 67890
17                    }
18                },
19                "prospect": {
20                    "data": {
21                        "type": "prospect",
22                        "id": 54321
23                    }
24                }
25            },
26            "links": {
27                "self": "https://api.outreach.io/api/v2/sequenceStates/12345"
28            }
29        },
30        {
31            "type": "sequenceState",
32            "id": 12346,
33            "attributes": {
34                "state": "active",
35                "createdAt": "2023-05-14T15:45:00Z",
36                "updatedAt": "2023-05-14T15:45:00Z",
37                "activeAt": "2023-05-14T15:45:00Z"
38            },
39            "relationships": {
40                "sequence": {
41                    "data": {
42                        "type": "sequence",
43                        "id": 67891
44                    }
45                },
46                "prospect": {
47                    "data": {
48                        "type": "prospect",
49                        "id": 54322
50                    }
51                }
52            },
53            "links": {
54                "self": "https://api.outreach.io/api/v2/sequenceStates/12346"
55            }
56        }
57    ],
58    "meta": {
59        "count": 2
60    }
61}

List sequence steps
Copy

Get a list of sequence steps in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "filters": [
4        {
5            "field": "stepType",
6            "criteria": "email"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "displayName",
15        "stepType",
16        "createdAt",
17        "order"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "sequenceStep",
5            "id": 12345,
6            "attributes": {
7                "displayName": "Introduction Email",
8                "stepType": "email",
9                "createdAt": "2023-06-15T10:30:00Z",
10                "order": 1
11            },
12            "relationships": {
13                "sequence": {
14                    "data": {
15                        "type": "sequence",
16                        "id": 789
17                    }
18                }
19            },
20            "links": {
21                "self": "https://api.outreach.io/api/v2/sequenceSteps/12345"
22            }
23        },
24        {
25            "type": "sequenceStep",
26            "id": 12346,
27            "attributes": {
28                "displayName": "Follow-up Email",
29                "stepType": "email",
30                "createdAt": "2023-06-14T14:45:00Z",
31                "order": 2
32            },
33            "relationships": {
34                "sequence": {
35                    "data": {
36                        "type": "sequence",
37                        "id": 789
38                    }
39                }
40            },
41            "links": {
42                "self": "https://api.outreach.io/api/v2/sequenceSteps/12346"
43            }
44        }
45    ],
46    "meta": {
47        "count": 2
48    }
49}

List sequences
Copy

Get a list of sequences in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "Welcome Sequence"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "name",
15        "description",
16        "createdAt",
17        "enabled"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "sequence",
5            "id": 123,
6            "attributes": {
7                "name": "Welcome Sequence",
8                "description": "A sequence to welcome new customers",
9                "createdAt": "2023-06-01T10:00:00Z",
10                "enabled": true
11            },
12            "relationships": {
13                "creator": {
14                    "data": {
15                        "type": "user",
16                        "id": 456
17                    }
18                },
19                "owner": {
20                    "data": {
21                        "type": "user",
22                        "id": 789
23                    }
24                }
25            },
26            "links": {
27                "self": "https://api.outreach.io/api/v2/sequences/123"
28            }
29        },
30        {
31            "type": "sequence",
32            "id": 124,
33            "attributes": {
34                "name": "Welcome Sequence - VIP",
35                "description": "A sequence to welcome new VIP customers",
36                "createdAt": "2023-05-15T14:30:00Z",
37                "enabled": true
38            },
39            "relationships": {
40                "creator": {
41                    "data": {
42                        "type": "user",
43                        "id": 456
44                    }
45                },
46                "owner": {
47                    "data": {
48                        "type": "user",
49                        "id": 789
50                    }
51                }
52            },
53            "links": {
54                "self": "https://api.outreach.io/api/v2/sequences/124"
55            }
56        }
57    ],
58    "meta": {
59        "count": 2
60    }
61}

List stages
Copy

Get a list of stages in your Outreach account.

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "Qualified"
7        }
8    ],
9    "sort": {
10        "sort_by": "order",
11        "sort_direction": "asc"
12    },
13    "fields": [
14        "name",
15        "order",
16        "color"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "stage",
5            "id": 1,
6            "attributes": {
7                "name": "Qualified",
8                "order": 1,
9                "color": "#4CAF50"
10            },
11            "relationships": {
12                "creator": {
13                    "data": {
14                        "type": "user",
15                        "id": 101
16                    }
17                },
18                "prospects": {
19                    "links": {
20                        "related": "https://api.outreach.io/api/v2/stages/1/prospects"
21                    }
22                },
23                "updater": {
24                    "data": {
25                        "type": "user",
26                        "id": 102
27                    }
28                }
29            },
30            "links": {
31                "self": "https://api.outreach.io/api/v2/stages/1"
32            }
33        },
34        {
35            "type": "stage",
36            "id": 2,
37            "attributes": {
38                "name": "Discovery",
39                "order": 2,
40                "color": "#2196F3"
41            },
42            "relationships": {
43                "creator": {
44                    "data": {
45                        "type": "user",
46                        "id": 101
47                    }
48                },
49                "prospects": {
50                    "links": {
51                        "related": "https://api.outreach.io/api/v2/stages/2/prospects"
52                    }
53                },
54                "updater": {
55                    "data": {
56                        "type": "user",
57                        "id": 101
58                    }
59                }
60            },
61            "links": {
62                "self": "https://api.outreach.io/api/v2/stages/2"
63            }
64        }
65    ],
66    "meta": {
67        "count": 2
68    }
69}

List task priorities
Copy

Get a list of task priorities in your Outreach account.

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "High"
7        }
8    ],
9    "sort": {
10        "sort_by": "weight",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "color",
15        "name",
16        "weight"
17    ]
18}

Sample Output

1{
2    "data": [
3        {
4            "type": "taskPriority",
5            "id": 1,
6            "attributes": {
7                "color": 16711680,
8                "name": "High",
9                "weight": 3
10            },
11            "relationships": {
12                "sequenceSteps": {
13                    "links": {
14                        "related": "https://api.outreach.io/api/v2/sequenceSteps?filter[taskPriority]=1"
15                    }
16                },
17                "tasks": {
18                    "links": {
19                        "related": "https://api.outreach.io/api/v2/tasks?filter[taskPriority]=1"
20                    }
21                }
22            },
23            "links": {
24                "self": "https://api.outreach.io/api/v2/taskPriorities/1"
25            }
26        }
27    ],
28    "meta": {
29        "count": 1
30    }
31}

List tasks
Copy

Get a list of recent tasks in your Outreach account.

Sample Input

1{
2    "filters": [
3        {
4            "field": "dueAt",
5            "criteria": {
6                "from": "2023-06-01",
7                "to": "2023-06-30"
8            }
9        },
10        {
11            "field": "completed",
12            "criteria": false
13        }
14    ],
15    "sort": {
16        "sort_by": "dueAt",
17        "sort_direction": "asc"
18    },
19    "page_size": 50,
20    "fields": [
21        "action",
22        "dueAt",
23        "note",
24        "state",
25        "taskType"
26    ]
27}

Sample Output

1{
2    "data": [
3        {
4            "type": "task",
5            "id": 12345,
6            "attributes": {
7                "action": "Call",
8                "dueAt": "2023-06-15T10:00:00Z",
9                "note": "Follow up on proposal",
10                "state": "incomplete",
11                "taskType": "follow_up"
12            },
13            "relationships": {
14                "prospect": {
15                    "data": {
16                        "type": "prospect",
17                        "id": 67890
18                    }
19                },
20                "owner": {
21                    "data": {
22                        "type": "user",
23                        "id": 11111
24                    }
25                }
26            },
27            "links": {
28                "self": "https://api.outreach.io/api/v2/tasks/12345"
29            }
30        },
31        {
32            "type": "task",
33            "id": 12346,
34            "attributes": {
35                "action": "Email",
36                "dueAt": "2023-06-20T14:30:00Z",
37                "note": "Send product demo",
38                "state": "incomplete",
39                "taskType": "demo"
40            },
41            "relationships": {
42                "prospect": {
43                    "data": {
44                        "type": "prospect",
45                        "id": 67891
46                    }
47                },
48                "owner": {
49                    "data": {
50                        "type": "user",
51                        "id": 11112
52                    }
53                }
54            },
55            "links": {
56                "self": "https://api.outreach.io/api/v2/tasks/12346"
57            }
58        }
59    ],
60    "meta": {
61        "count": 2
62    }
63}

List templates
Copy

Get a list of templates in your Outreach account.

Sample Input

1{
2    "page_size": 50,
3    "filters": [
4        {
5            "field": "name",
6            "criteria": "Follow-up"
7        }
8    ],
9    "sort": {
10        "sort_by": "createdAt",
11        "sort_direction": "desc"
12    },
13    "fields": [
14        "name",
15        "subject",
16        "bodyHtml",
17        "createdAt",
18        "updatedAt"
19    ]
20}

Sample Output

1{
2    "data": [
3        {
4            "type": "template",
5            "id": 12345,
6            "attributes": {
7                "name": "Follow-up Email",
8                "subject": "Checking in on our recent conversation",
9                "bodyHtml": "<p>Hello {{prospect.firstName}},</p><p>I hope this email finds you well. I wanted to follow up on our recent conversation about...</p>",
10                "createdAt": "2023-05-01T10:30:00Z",
11                "updatedAt": "2023-05-15T14:45:00Z"
12            },
13            "relationships": {
14                "creator": {
15                    "data": {
16                        "type": "user",
17                        "id": 67890
18                    }
19                },
20                "owner": {
21                    "data": {
22                        "type": "user",
23                        "id": 67890
24                    }
25                }
26            },
27            "links": {
28                "self": "https://api.outreach.io/api/v2/templates/12345"
29            }
30        },
31        {
32            "type": "template",
33            "id": 12346,
34            "attributes": {
35                "name": "Follow-up Call",
36                "subject": "Quick call to discuss next steps",
37                "bodyHtml": "<p>Hi {{prospect.firstName}},</p><p>I'd like to schedule a quick call to discuss the next steps in our process. Are you available for a 15-minute chat this week?</p>",
38                "createdAt": "2023-04-28T09:15:00Z",
39                "updatedAt": "2023-05-10T11:20:00Z"
40            },
41            "relationships": {
42                "creator": {
43                    "data": {
44                        "type": "user",
45                        "id": 67891
46                    }
47                },
48                "owner": {
49                    "data": {
50                        "type": "user",
51                        "id": 67891
52                    }
53                }
54            },
55            "links": {
56                "self": "https://api.outreach.io/api/v2/templates/12346"
57            }
58        }
59    ],
60    "meta": {
61        "count": 2
62    }
63}

List users
Copy

Get a list of users in your Outreach account.

Sample Input

1{
2    "page_size": 2,
3    "filters": [
4        {
5            "field": "firstName",
6            "criteria": "John"
7        }
8    ],
9    "sort": {
10        "sort_by": "lastName",
11        "sort_direction": "asc"
12    },
13    "fields": [
14        "firstName",
15        "lastName",
16        "email",
17        "title"
18    ]
19}

Sample Output

1{
2    "data": [
3        {
4            "type": "user",
5            "id": 1234,
6            "attributes": {
7                "firstName": "John",
8                "lastName": "Doe",
9                "email": "john.doe@example.com",
10                "title": "Sales Representative"
11            },
12            "relationships": {
13                "role": {
14                    "data": "sales_rep"
15                }
16            },
17            "links": {
18                "self": "https://api.outreach.io/api/v2/users/1234"
19            }
20        },
21        {
22            "type": "user",
23            "id": 5678,
24            "attributes": {
25                "firstName": "John",
26                "lastName": "Smith",
27                "email": "john.smith@example.com",
28                "title": "Account Executive"
29            },
30            "relationships": {
31                "role": {
32                    "data": "account_exec"
33                }
34            },
35            "links": {
36                "self": "https://api.outreach.io/api/v2/users/5678"
37            }
38        }
39    ],
40    "meta": {
41        "count": "2"
42    }
43}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1{
2    "method": "POST",
3    "url": {
4        "endpoint": "/api/v1/users"
5    },
6    "headers": [
7        {
8            "key": "Content-Type",
9            "value": "application/json"
10        },
11        {
12            "key": "Authorization",
13            "value": "Bearer token123"
14        }
15    ],
16    "query_parameters": [
17        {
18            "key": "include_details",
19            "value": "true"
20        }
21    ],
22    "body": {
23        "raw": {
24            "name": "John Doe",
25            "email": "john.doe@example.com",
26            "role": "manager"
27        }
28    },
29    "include_raw_body": true,
30    "parse_response": "true"
31}

Sample Output

1{
2    "response": {
3        "status_code": 201,
4        "headers": {
5            "Content-Type": "application/json",
6            "Location": "/api/v1/users/12345"
7        },
8        "body": {
9            "id": "12345",
10            "name": "John Doe",
11            "email": "john.doe@example.com",
12            "role": "manager",
13            "created_at": "2023-05-10T14:30:00Z"
14        }
15    }
16}

Set sequence state action
Copy

Set an action on a sequence state from your Outreach account, using it's unique ID.

Sample Input

1{
2    "sequence_state_id": "12345",
3    "action": "pause"
4}

Sample Output

1{
2    "data": {
3        "type": "sequenceState",
4        "id": 12345,
5        "attributes": {
6            "activeAt": "2023-05-15T10:30:00Z",
7            "bounceCount": 0,
8            "callCompletedAt": null,
9            "clickCount": 2,
10            "createdAt": "2023-05-10T09:00:00Z",
11            "deliverCount": 1,
12            "errorReason": null,
13            "failureCount": 0,
14            "negativeReplyCount": 0,
15            "neutralReplyCount": 0,
16            "openCount": 3,
17            "optOutCount": 0,
18            "pauseReason": "User requested pause",
19            "positiveReplyCount": 1,
20            "repliedAt": "2023-05-16T14:45:00Z",
21            "replyCount": 1,
22            "scheduleCount": 2,
23            "state": "paused",
24            "stateChangedAt": "2023-05-17T08:00:00Z",
25            "updatedAt": "2023-05-17T08:00:00Z"
26        },
27        "relationships": {
28            "activeStepMailings": {
29                "data": [],
30                "links": {
31                    "related": "https://api.outreach.io/api/v2/sequenceStates/12345/activeStepMailings"
32                },
33                "meta": {
34                    "count": 0
35                }
36            },
37            "activeStepTasks": {
38                "data": [],
39                "links": {
40                    "related": "https://api.outreach.io/api/v2/sequenceStates/12345/activeStepTasks"
41                },
42                "meta": {
43                    "count": 0
44                }
45            },
46            "calls": {
47                "links": {
48                    "related": "https://api.outreach.io/api/v2/sequenceStates/12345/calls"
49                }
50            },
51            "creator": {
52                "data": {
53                    "type": "user",
54                    "id": 67890
55                }
56            },
57            "mailbox": {
58                "data": {
59                    "type": "mailbox",
60                    "id": 54321
61                }
62            },
63            "mailings": {
64                "links": {
65                    "related": "https://api.outreach.io/api/v2/sequenceStates/12345/mailings"
66                }
67            },
68            "opportunity": {
69                "data": {
70                    "type": "opportunity",
71                    "id": 98765
72                }
73            },
74            "prospect": {
75                "data": {
76                    "type": "prospect",
77                    "id": 11111
78                }
79            },
80            "sequence": {
81                "data": {
82                    "type": "sequence",
83                    "id": 22222
84                }
85            },
86            "sequenceStep": {
87                "data": {
88                    "type": "sequenceStep",
89                    "id": 33333
90                }
91            },
92            "tasks": {
93                "links": {
94                    "related": "https://api.outreach.io/api/v2/sequenceStates/12345/tasks"
95                }
96            }
97        },
98        "links": {
99            "self": "https://api.outreach.io/api/v2/sequenceStates/12345"
100        }
101    }
102}

Set task action
Copy

Set an action on a task from your Outreach account, using their unique ID.

Sample Input

1{
2    "task_id": 12345,
3    "action": {
4        "completion_note": "Task completed successfully",
5        "completion_action": "finish_replied"
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "task",
4        "id": 12345,
5        "attributes": {
6            "action": "complete",
7            "completed": true,
8            "completedAt": "2023-05-15T14:30:00Z",
9            "createdAt": "2023-05-10T09:00:00Z",
10            "dueAt": "2023-05-15T17:00:00Z",
11            "note": "Task completed successfully",
12            "scheduledAt": "2023-05-15T10:00:00Z",
13            "state": "completed",
14            "stateChangedAt": "2023-05-15T14:30:00Z",
15            "taskType": "follow_up",
16            "updatedAt": "2023-05-15T14:30:00Z"
17        },
18        "relationships": {
19            "account": {
20                "data": {
21                    "type": "account",
22                    "id": 67890
23                }
24            },
25            "call": {
26                "data": null
27            },
28            "calls": {
29                "links": {
30                    "related": "https://api.outreach.io/api/v2/tasks/12345/calls"
31                }
32            },
33            "completer": {
34                "data": {
35                    "type": "user",
36                    "id": 54321
37                }
38            },
39            "creator": {
40                "data": {
41                    "type": "user",
42                    "id": 98765
43                }
44            },
45            "mailing": {
46                "data": null
47            },
48            "mailings": {
49                "links": {
50                    "related": "https://api.outreach.io/api/v2/tasks/12345/mailings"
51                }
52            },
53            "owner": {
54                "data": {
55                    "type": "user",
56                    "id": 54321
57                }
58            },
59            "prospect": {
60                "data": {
61                    "type": "prospect",
62                    "id": 11111
63                }
64            },
65            "sequence": {
66                "data": {
67                    "type": "sequence",
68                    "id": 22222
69                }
70            },
71            "sequenceState": {
72                "data": {
73                    "type": "sequenceState",
74                    "id": 33333
75                }
76            },
77            "sequenceStep": {
78                "data": {
79                    "type": "sequenceStep",
80                    "id": 44444
81                }
82            },
83            "subject": {
84                "data": null
85            },
86            "taskPriority": {
87                "data": {
88                    "type": "taskPriority",
89                    "id": 2
90                }
91            },
92            "template": {
93                "data": null
94            }
95        },
96        "links": {
97            "self": "https://api.outreach.io/api/v2/tasks/12345"
98        }
99    }
100}

Update account
Copy

Update an account by ID in your Outreach account.

Sample Input

1{
2    "account_id": 12345,
3    "attributes": {
4        "name": "Acme Corporation",
5        "natural_name": "Acme Corp",
6        "company_type": "Enterprise",
7        "domain": "www.acme.com",
8        "website_url": "https://www.acme.com",
9        "custom_id": "ACME001",
10        "description": "Leading provider of innovative solutions",
11        "followers": "10000",
12        "founded_at": "1985-03-15",
13        "industry": "Technology",
14        "locality": "San Francisco, CA",
15        "number_of_employees": 5000,
16        "named": true,
17        "linked_in_url": "https://www.linkedin.com/company/acme-corporation",
18        "linked_in_employees": 4800,
19        "tags": "tech,innovation,enterprise",
20        "custom_fields": {
21            "custom_1": "High Priority",
22            "custom_2": "West Coast",
23            "custom_3": "Q3 Target"
24        }
25    },
26    "relationships": {
27        "owner": 67890
28    }
29}

Sample Output

1{
2    "data": {
3        "type": "account",
4        "id": 12345,
5        "attributes": {
6            "name": "Acme Corporation",
7            "naturalName": "Acme Corp",
8            "companyType": "Enterprise",
9            "domain": "www.acme.com",
10            "websiteUrl": "https://www.acme.com",
11            "customId": "ACME001",
12            "description": "Leading provider of innovative solutions",
13            "followers": 10000,
14            "foundedAt": "1985-03-15",
15            "industry": "Technology",
16            "locality": "San Francisco, CA",
17            "numberOfEmployees": 5000,
18            "named": true,
19            "linkedInUrl": "https://www.linkedin.com/company/acme-corporation",
20            "linkedInEmployees": 4800,
21            "tags": [
22                "tech",
23                "innovation",
24                "enterprise"
25            ],
26            "custom1": "High Priority",
27            "custom2": "West Coast",
28            "custom3": "Q3 Target",
29            "updatedAt": "2023-05-15T14:30:00Z",
30            "createdAt": "2022-01-01T10:00:00Z",
31            "touchedAt": "2023-05-15T14:30:00Z"
32        },
33        "relationships": {
34            "owner": {
35                "data": {
36                    "type": "user",
37                    "id": 67890
38                }
39            }
40        },
41        "links": {
42            "self": "https://api.outreach.io/api/v2/accounts/12345"
43        }
44    }
45}

Update call disposition
Copy

Update a call disposition in your outreach account.

Sample Input

1{
2    "call_disposition_id": 123,
3    "attributes": {
4        "name": "Follow-up Required",
5        "order": 2,
6        "outcome": "completed"
7    }
8}

Sample Output

1{
2    "data": {
3        "type": "callDisposition",
4        "id": 123,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "name": "Follow-up Required",
8            "order": 2,
9            "outcome": "completed",
10            "updatedAt": "2023-05-15T14:45:00Z"
11        },
12        "relationships": {
13            "calls": {
14                "links": {
15                    "related": "https://api.outreach.io/api/v2/callDispositions/123/calls"
16                }
17            },
18            "creator": {
19                "data": {
20                    "type": "user",
21                    "id": 456
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/callDispositions/123"
27        }
28    }
29}

Update call purpose
Copy

Update a call purpose in your outreach account.

Sample Input

1{
2    "call_purpose_id": 123,
3    "attributes": {
4        "name": "Follow-up Call",
5        "order": 2
6    }
7}

Sample Output

1{
2    "data": {
3        "type": "callPurpose",
4        "id": 123,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "name": "Follow-up Call",
8            "order": 2,
9            "updatedAt": "2023-05-15T14:45:00Z"
10        },
11        "relationships": {
12            "calls": {
13                "links": {
14                    "related": "https://api.outreach.io/api/v2/calls?filter[purpose]=123"
15                }
16            },
17            "creator": {
18                "data": {
19                    "type": "user",
20                    "id": 456
21                }
22            }
23        },
24        "links": {
25            "self": "https://api.outreach.io/api/v2/callPurposes/123"
26        }
27    }
28}

Update opportunity
Copy

Update an opportunity by ID in your Outreach account.

Sample Input

1{
2    "opportunity_id": 12345,
3    "attributes": {
4        "name": "Enterprise Software Deal",
5        "amount": 100000,
6        "close_date": "2023-12-31T23:59:59Z",
7        "description": "Potential large-scale software implementation for XYZ Corp",
8        "external_created_at": "2023-06-15T10:30:00Z",
9        "next_step": "Schedule demo with CTO",
10        "opportunity_type": "New Business",
11        "probability": 60,
12        "prospecting_rep_id": "REP789",
13        "tags": [
14            "enterprise",
15            "software",
16            "high-value"
17        ],
18        "custom_fields": {
19            "custom_1": "Q4 Target",
20            "custom_2": "Referred by John Doe"
21        }
22    }
23}

Sample Output

1{
2    "data": {
3        "type": "opportunity",
4        "id": 12345,
5        "attributes": {
6            "amount": 100000,
7            "closeDate": "2023-12-31T23:59:59Z",
8            "createdAt": "2023-06-15T10:30:00Z",
9            "currencyType": "USD",
10            "custom1": "Q4 Target",
11            "custom2": "Referred by John Doe",
12            "description": "Potential large-scale software implementation for XYZ Corp",
13            "externalCreatedAt": "2023-06-15T10:30:00Z",
14            "name": "Enterprise Software Deal",
15            "nextStep": "Schedule demo with CTO",
16            "opportunityType": "New Business",
17            "probability": 60,
18            "prospectingRepId": "REP789",
19            "tags": [
20                "enterprise",
21                "software",
22                "high-value"
23            ],
24            "updatedAt": "2023-06-20T14:45:30Z"
25        },
26        "relationships": {
27            "account": {
28                "data": {
29                    "type": "account",
30                    "id": 67890
31                }
32            },
33            "creator": {
34                "data": {
35                    "type": "user",
36                    "id": 11111
37                }
38            },
39            "opportunityStage": {
40                "data": {
41                    "type": "opportunityStage",
42                    "id": 22222
43                }
44            },
45            "owner": {
46                "data": {
47                    "type": "user",
48                    "id": 33333
49                }
50            },
51            "prospects": {
52                "links": {
53                    "related": "https://api.outreach.io/api/v2/opportunities/12345/prospects"
54                }
55            }
56        },
57        "links": {
58            "self": "https://api.outreach.io/api/v2/opportunities/12345"
59        }
60    }
61}

Update opportunity prospect role
Copy

Update an opportunity by ID in your Outreach account.

Sample Input

1{
2    "prospect_role_id": 12345,
3    "attributes": {
4        "role": "Decision Maker",
5        "primary": true
6    },
7    "relationships": {
8        "opportunity": 67890,
9        "prospect": 54321
10    }
11}

Sample Output

1{
2    "data": {
3        "type": "opportunityProspectRole",
4        "id": 12345,
5        "attributes": {
6            "createdAt": "2023-05-15T10:30:00Z",
7            "primary": true,
8            "role": "Decision Maker",
9            "updatedAt": "2023-05-15T14:45:00Z"
10        },
11        "relationships": {
12            "opportunity": {
13                "data": {
14                    "type": "opportunity",
15                    "id": 67890
16                }
17            },
18            "prospect": {
19                "data": {
20                    "type": "prospect",
21                    "id": 54321
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/opportunityProspectRoles/12345"
27        }
28    }
29}

Update opportunity stage
Copy

Update an opportunity stage by ID in your Outreach account.

Sample Input

1{
2    "opportunity_stage_id": 123,
3    "attributes": {
4        "name": "Negotiation",
5        "color": "#FFA500",
6        "order": 3
7    }
8}

Sample Output

1{
2    "data": {
3        "type": "opportunityStage",
4        "id": 123,
5        "attributes": {
6            "color": "#FFA500",
7            "createdAt": "2023-05-15T10:30:00Z",
8            "name": "Negotiation",
9            "order": 3,
10            "updatedAt": "2023-05-15T14:45:00Z"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 456
17                }
18            },
19            "opportunities": {
20                "links": {
21                    "related": "https://api.outreach.io/api/v2/opportunityStages/123/opportunities"
22                }
23            }
24        },
25        "links": {
26            "self": "https://api.outreach.io/api/v2/opportunityStages/123"
27        }
28    }
29}

Update stage
Copy

Update a stage by ID in your Outreach account.

Sample Input

1{
2    "stage_id": 123,
3    "attributes": {
4        "name": "Qualified Lead",
5        "color": "#4287f5",
6        "order": 2
7    }
8}

Sample Output

1{
2    "data": {
3        "type": "stage",
4        "id": 123,
5        "attributes": {
6            "color": "#4287f5",
7            "createdAt": "2023-05-15T10:30:00Z",
8            "name": "Qualified Lead",
9            "order": 2,
10            "updatedAt": "2023-05-15T14:45:00Z"
11        },
12        "relationships": {
13            "creator": {
14                "data": {
15                    "type": "user",
16                    "id": 456
17                }
18            },
19            "prospects": {
20                "links": {
21                    "related": "https://api.outreach.io/api/v2/stages/123/prospects"
22                }
23            },
24            "updater": {
25                "data": {
26                    "type": "user",
27                    "id": 789
28                }
29            }
30        },
31        "links": {
32            "self": "https://api.outreach.io/api/v2/stages/123"
33        }
34    }
35}