The Outreach connector lets your AI agent act in each user's Outreach account. Each user signs in to Outreach once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 211 tools.
- Tools
- 211
- What they doRead · write · destructive
- 90 · 84 · 3790 read84 write37 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Outreach app
What you can do
- Manage prospects: create, update, and delete prospects, and add notes to their profiles
- Run sequences: build sequences and steps, enroll prospects, and pause, resume, or deactivate them
- Manage accounts and opportunities: create and update accounts and opportunities and track their stages
- Handle tasks and calls: create, complete, and reschedule tasks, and log calls with outcomes
- Manage templates and snippets: create and update email templates and reusable snippets for reps
- Review email activity: list sent and scheduled mailings and the mailboxes they come from
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Outreach connection
In AgentKit > Connections, create an Outreach connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Outreach connections use your own OAuth app. Register one with Outreach and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Outreach connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'outreach'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Outreach:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'outreach_account_notes_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "outreach"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Outreach:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="outreach_account_notes_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_tooloutreach_account_notes_getGet one account note in Outreach by its ID.Read-onlyGet Account Note
Get one account note in Outreach by its ID. Returns the record's id and attributes (createdAt, message, noteType, opportunityAssociationRule, pinned) plus relationship links. Use this when you already have the id. Use outreach_account_notes_list to find records. Requires the numeric account note id.
Inputs
account_note_idintegerrequired- Numeric Outreach ID of the account note. Find it with outreach_account_notes_list.
outreach_account_notes_listList notes logged against an account in Outreach, with pagination.Read-onlyList Account Notes
List notes logged against an account in Outreach, with pagination.
Inputs
filter_account_idinteger- Filter notes by account ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_accounts_getRetrieve a single account by ID from Outreach.Read-onlyGet Account
Retrieve a single account by ID from Outreach.
Inputs
account_idintegerrequired- The unique identifier of the account to retrieve
outreach_accounts_listList all accounts in Outreach with optional filtering, sorting, and pagination.Read-onlyList Accounts
List all accounts in Outreach with optional filtering, sorting, and pagination.
Inputs
filter_domainstring- Filter accounts by domain
filter_namestring- Filter accounts by name
page_offsetinteger- Offset for pagination (number of records to skip)
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_audit_logs_listList audit log records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Audit Logs
List audit log records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (action, additionalInfo, agent, changes, eventName, globalId, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Filters apply to: action, eventName, requestId, result, timestamp. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_actionstring- Filter by action. The action taken. (maximum 255 characters.)
filter_event_namestring- Filter by event name. Audit event name. (maximum 255 characters.)
filter_request_idstring- Filter by request id. The UUID of the request. RequestId groups dependent events. (maximum 36 characters.)
filter_resultstring- Filter by result. The result of the action: `completed`. `pending` or `failed`. (maximum 255 characters.)
filter_timestampstring- Filter by timestamp. The timestamp of the action. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: action, eventName, requestId, result, timestamp. Example: -action
outreach_batch_items_getGet one batch item in Outreach by its ID.Read-onlyGet Batch Item
Get one batch item in Outreach by its ID. Returns the record's id and attributes (batchId, createdAt, data, failed, info, state) plus relationship links. Use this when you already have the id. Use outreach_batch_items_list to find records. Requires the numeric batch item id.
Inputs
batch_item_idintegerrequired- Numeric Outreach ID of the batch item. Find it with outreach_batch_items_list.
outreach_batch_items_listList batch item records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Batch Items
List batch item records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (batchId, createdAt, data, failed, info, state) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_batch_items_get for one record by id. Filters apply to: batchId, failed, state. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_batch_idinteger- Filter by batch id. The id of the batch this item belongs to.
filter_failedboolean- Filter by failed. Whether this batch item failed during processing.
filter_statestring- Filter by state. The current state of the batch item. (maximum 255 characters.)
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: batchId, failed, state. Example: -batchId
outreach_batches_getGet one batch in Outreach by its ID.Read-onlyGet Batch
Get one batch in Outreach by its ID. Returns the record's id and attributes (action, canceledAt, confirmCount, confirmedAt, confirmedCountRequired, createdAt, and more) plus relationship links. Use this when you already have the id. Use outreach_batches_list to find records. Requires the numeric batch id.
Inputs
batch_idintegerrequired- Numeric Outreach ID of the batch. Find it with outreach_batches_list.
outreach_batches_listList batch records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Batches
List batch records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (action, canceledAt, confirmCount, confirmedAt, confirmedCountRequired, createdAt, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_batches_get for one record by id. Filters apply to: action, state, total. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_actionstring- Filter by action. Action performed on the batch. (maximum 255 characters.)
filter_statestring- Filter by state. The current state of the batch. (maximum 255 characters.)
filter_totalinteger- Filter by total. The total number of batch items associated with this batch.
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, finishedAt, state, total. Example: -createdAt
outreach_call_dispositions_getGet one call disposition in Outreach by its ID.Read-onlyGet Call Disposition
Get one call disposition in Outreach by its ID. Returns the record's id and attributes (createdAt, name, order, outcome, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_call_dispositions_list to find records. Requires the numeric call disposition id.
Inputs
call_disposition_idintegerrequired- Numeric Outreach ID of the call disposition. Find it with outreach_call_dispositions_list.
outreach_call_dispositions_listList available call dispositions (outcome categories, e.g.Read-onlyList Call Dispositions
List available call dispositions (outcome categories, e.g. 'Meeting Scheduled') configured in Outreach. Use the returned IDs with outreach_calls_create's call_disposition_id field.
Inputs
filter_namestring- Filter call dispositions by name
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_call_purposes_getGet one call purpose in Outreach by its ID.Read-onlyGet Call Purpose
Get one call purpose in Outreach by its ID. Returns the record's id and attributes (createdAt, name, order, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_call_purposes_list to find records. Requires the numeric call purpose id.
Inputs
call_purpose_idintegerrequired- Numeric Outreach ID of the call purpose. Find it with outreach_call_purposes_list.
outreach_call_purposes_listList available call purposes (e.g.Read-onlyList Call Purposes
List available call purposes (e.g. 'Initial Contact') configured in Outreach. Use the returned IDs with outreach_calls_create's call_purpose_id field.
Inputs
filter_namestring- Filter call purposes by name
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_calls_getRetrieve a single call record by ID from Outreach, including direction, outcome, note, recording URL, and related prospect.Read-onlyGet Call
Retrieve a single call record by ID from Outreach, including direction, outcome, note, recording URL, and related prospect.
Inputs
call_idintegerrequired- The unique identifier of the call to retrieve
outreach_calls_listList call records in Outreach with optional filtering by prospect, direction, or outcome.Read-onlyList Calls
List call records in Outreach with optional filtering by prospect, direction, or outcome.
Inputs
filter_directionstring- Filter calls by direction. Options: inbound, outbound
filter_prospect_idinteger- Filter calls by prospect ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_compliance_requests_getGet one compliance request in Outreach by its ID.Read-onlyGet Compliance Request
Get one compliance request in Outreach by its ID. Returns the record's id and attributes (batchComplianceRequestUuid, createdAt, objectType, pii, requestObjectId, requestType, and more) plus relationship links. Use this when you already have the id. Use outreach_compliance_requests_list to find records. Requires the numeric compliance request id.
Inputs
compliance_request_idintegerrequired- Numeric Outreach ID of the compliance request. Find it with outreach_compliance_requests_list.
outreach_compliance_requests_listList compliance request records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Compliance Requests
List compliance request records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (batchComplianceRequestUuid, createdAt, objectType, pii, requestObjectId, requestType, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_compliance_requests_get for one record by id. Filters apply to: state, uuid. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_statestring- Filter by state. The current state of the compliance request, can be 'pending', 'running', 'failed', or 'done'. The states on the higher level abstraction, the batch compliance request, do not map 1:1 to these states. The only states that the batch compliance request will report are either 'pending' or 'done'. (maximum 32 characters.)
filter_uuidstring- Filter by uuid. The UUID of the compliance request. (maximum 255 characters.)
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: state, uuid. Example: -state
outreach_content_categories_getGet one content category in Outreach by its ID.Read-onlyGet Content Category
Get one content category in Outreach by its ID. Returns the record's id and attributes (allowSequences, allowSnippets, allowTemplates, color, createdAt, name, and more) plus relationship links. Use this when you already have the id. Use outreach_content_categories_list to find records. Requires the numeric content category id.
Inputs
content_category_idintegerrequired- Numeric Outreach ID of the content category. Find it with outreach_content_categories_list.
outreach_content_categories_listList content category records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Content Categories
List content category records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (allowSequences, allowSnippets, allowTemplates, color, createdAt, name, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_content_categories_get for one record by id. Filters apply to: createdAt, name, updatedAt. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the content category was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The name of the content category. (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the content category was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, updatedAt. Example: -createdAt
outreach_content_category_memberships_getGet one content category membership in Outreach by its ID.Read-onlyGet Content Category Membership
Get one content category membership in Outreach by its ID. Returns the record's id and attributes (createdAt, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_content_category_memberships_list to find records. Requires the numeric content category membership id.
Inputs
content_category_membership_idintegerrequired- Numeric Outreach ID of the content category membership. Find it with outreach_content_category_memberships_list.
outreach_content_category_memberships_listList content category membership records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Content Category Memberships
List content category membership records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_content_category_memberships_get for one record by id. Filters apply to: createdAt, updatedAt, contentCategory.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_content_category_idinteger- Filter by the numeric ID of the related content category.
filter_created_atstring- Filter by created at. The date and time the content category membership was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_updated_atstring- Filter by updated at. The date and time the content category membership was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, updatedAt. Example: -createdAt
outreach_content_category_ownerships_listList content category ownership records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Content Category Ownerships
List content category ownership records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Filters apply to: createdAt, updatedAt, contentCategory.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_content_category_idinteger- Filter by the numeric ID of the related content category.
filter_created_atstring- Filter by created at. The date and time the content category ownership was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_updated_atstring- Filter by updated at. The date and time the content category ownership was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, updatedAt. Example: -createdAt
outreach_duties_listList duty records in Outreach, optionally filtered and paged.Read-onlyList Duties
List duty records in Outreach, optionally filtered and paged. Returns each record's id and attributes (dutyType, symbolicName) plus relationship links, with links.next for the next page. Use this to browse or find ids. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
outreach_email_address_getGet a single prospect email address from Outreach by ID.Read-onlyGet Email Address
Get a single prospect email address from Outreach by ID.
Inputs
email_address_idintegerrequired- The unique identifier of the email address to retrieve
outreach_email_addresses_listList prospect email addresses in Outreach, with optional filtering by email, prospect ID, or status, and pagination.Read-onlyList Email Addresses
List prospect email addresses in Outreach, with optional filtering by email, prospect ID, or status, and pagination.
Inputs
filter_emailstring- Filter by the raw email address value
filter_prospect_idinteger- Filter email addresses by owning prospect ID
filter_statusstring- Filter email addresses by status
page_offsetinteger- Offset for pagination (number of records to skip)
page_sizeinteger- Number of results per page (max 1000)
outreach_favorites_getGet one favorite in Outreach by its ID.Read-onlyGet Favorite
Get one favorite in Outreach by its ID. Returns the record's id and attributes (createdAt, targetId, targetType, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_favorites_list to find records. Requires the numeric favorite id.
Inputs
favorite_idintegerrequired- Numeric Outreach ID of the favorite. Find it with outreach_favorites_list.
outreach_favorites_listList favorite records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Favorites
List favorite records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, targetId, targetType, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_favorites_get for one record by id. Filters apply to: createdAt, targetId, targetType, updatedAt, user.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the favorite was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_target_idinteger- Filter by target id. The ID of record that was favorited.
filter_target_typestring- Filter by target type. The type of record that was favorited. (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the favorite was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_user_idinteger- Filter by the numeric ID of the related user.
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, updatedAt. Example: -createdAt
outreach_imports_getGet one import in Outreach by its ID.Read-onlyGet Import
Get one import in Outreach by its ID. Returns the record's id and attributes (createdAt, dupeMethod, dupes, errorReason, externalId, externalName, and more) plus relationship links. Use this when you already have the id. Requires the numeric import id.
Inputs
import_idintegerrequired- Numeric Outreach ID of the import.
outreach_kaia_recordings_getGet one Kaia meeting or call recording in Outreach by ID.Read-onlyGet Kaia Recording
Get one Kaia meeting or call recording in Outreach by ID. Returns the recording's title, start and end time, state, provider, format, participants, host, recordingUrl, sourceId, topics, and a transcriptUrl (a self-authenticating transcript JSON link valid for 2 hours; fetch it without a Bearer header). Use this when you already have a recording ID. Use outreach_kaia_recordings_list to find recordings by updated time. Requires a recording ID from outreach_kaia_recordings_list. Outreach does not expose Kaia AI summaries or action items through its API, only transcripts and topics.
Inputs
idintegerrequired- Numeric Outreach ID of the Kaia recording to fetch, from outreach_kaia_recordings_list. Example: 12345
outreach_kaia_recordings_listList Kaia meeting and call recordings in Outreach that were updated within a closed time range.Read-onlyList Kaia Recordings
List Kaia meeting and call recordings in Outreach that were updated within a closed time range. Returns each recording's title, start and end time, state, provider, format, participants, host, recordingUrl, sourceId, topics, and a transcriptUrl (a self-authenticating transcript JSON link valid for 2 hours; fetch it without a Bearer header), plus links.next for the next page. Use this for incremental sync or to find recordings in a window. Use outreach_kaia_recordings_get for one recording by ID, and outreach_calls_list for dialer call activity (a recording with format=call has a sourceId equal to the Outreach call ID). Both updated_at_from and updated_at_to are required because Outreach rejects an open-ended range with HTTP 400. Outreach does not expose Kaia AI summaries or action items through its API, only transcripts and topics.
Inputs
updated_at_fromstringrequired- Start of the updatedAt range, as an ISO 8601 timestamp. Required together with updated_at_to because Outreach rejects open-ended ranges. Example: 2025-01-01T00:00:00Z
updated_at_tostringrequired- End of the updatedAt range, as an ISO 8601 timestamp. Required together with updated_at_from because Outreach rejects open-ended ranges. Example: 2025-01-31T23:59:59Z
page_afterstring- Cursor for the next page: the opaque page[after] value taken from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of recordings to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields are createdAt, endTime, startTime, and updatedAt. Example: -updatedAt
outreach_mail_aliases_getGet one mail alias in Outreach by its ID.Read-onlyGet Mail Alias
Get one mail alias in Outreach by its ID. Returns the record's id and attributes (canSend, createdAt, email, emailHash, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_mail_aliases_list to find records. Requires the numeric mail alias id.
Inputs
mail_alias_idintegerrequired- Numeric Outreach ID of the mail alias. Find it with outreach_mail_aliases_list.
outreach_mail_aliases_listList mail alias records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Mail Aliases
List mail alias records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (canSend, createdAt, email, emailHash, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_mail_aliases_get for one record by id. Filters apply to: createdAt, updatedAt, mailbox.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date the alias was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_mailbox_idinteger- Filter by the numeric ID of the related mailbox.
filter_updated_atstring- Filter by updated at. The date the alias was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, updatedAt. Example: -createdAt
outreach_mailboxes_getRetrieve a single mailbox by ID from Outreach, including its email address, sender name, and sync status.Read-onlyGet Mailbox
Retrieve a single mailbox by ID from Outreach, including its email address, sender name, and sync status.
Inputs
mailbox_idintegerrequired- The unique identifier of the mailbox to retrieve
outreach_mailboxes_listList all mailboxes (sender email addresses) configured in Outreach.Read-onlyList Mailboxes
List all mailboxes (sender email addresses) configured in Outreach. Mailboxes are required when enrolling prospects in sequences.
Inputs
filter_emailstring- Filter mailboxes by email address
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_mailings_getRetrieve a single mailing by ID from Outreach, including its body, subject, state, and related prospect details.Read-onlyGet Mailing
Retrieve a single mailing by ID from Outreach, including its body, subject, state, and related prospect details.
Inputs
mailing_idintegerrequired- The unique identifier of the mailing to retrieve
outreach_mailings_listList mailings (emails sent or scheduled) in Outreach with optional filtering and pagination.Read-onlyList Mailings
List mailings (emails sent or scheduled) in Outreach with optional filtering and pagination.
Inputs
filter_prospect_idinteger- Filter mailings by prospect ID
filter_statestring- Filter by mailing state. Options: bounced, delivered, delivering, drafted, failed, opened, placeholder, queued, replied, scheduled
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_opportunities_getRetrieve a single opportunity by ID from Outreach, including its name, amount, close date, and stage.Read-onlyGet Opportunity
Retrieve a single opportunity by ID from Outreach, including its name, amount, close date, and stage.
Inputs
opportunity_idintegerrequired- The unique identifier of the opportunity to retrieve
outreach_opportunities_listList opportunities in Outreach with optional filtering by name, prospect, or account.Read-onlyList Opportunities
List opportunities in Outreach with optional filtering by name, prospect, or account.
Inputs
filter_namestring- Filter opportunities by name
filter_prospect_idinteger- Filter by prospect ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_opportunity_prospect_roles_getGet one opportunity prospect role in Outreach by its ID.Read-onlyGet Opportunity Prospect Role
Get one opportunity prospect role in Outreach by its ID. Returns the record's id and attributes (createdAt, primary, role, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_opportunity_prospect_roles_list to find records. Requires the numeric opportunity prospect role id.
Inputs
opportunity_prospect_role_idintegerrequired- Numeric Outreach ID of the opportunity prospect role. Find it with outreach_opportunity_prospect_roles_list.
outreach_opportunity_prospect_roles_listList OpportunityProspectRole records in Outreach, which link a prospect to an opportunity with a role (e.g.Read-onlyList Opportunity Prospect Roles
List OpportunityProspectRole records in Outreach, which link a prospect to an opportunity with a role (e.g. Decision Maker, Champion).
Inputs
filter_opportunity_idinteger- Filter by opportunity ID
filter_prospect_idinteger- Filter by prospect ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_org_settings_getGet one org setting in Outreach by its ID.Read-onlyGet Org Setting
Get one org setting in Outreach by its ID. Returns the record's id and attributes (contactExclusions, prospectEmailExclusions, sendExclusions) plus relationship links. Use this when you already have the id. Requires the org setting id (a UUID).
Inputs
org_setting_idstringrequired- ID of the org setting (a UUID in Outreach's API reference).
outreach_personas_getGet one persona in Outreach by its ID.Read-onlyGet Persona
Get one persona in Outreach by its ID. Returns the record's id and attributes (createdAt, description, name, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_personas_list to find records. Requires the numeric persona id.
Inputs
persona_idintegerrequired- Numeric Outreach ID of the persona. Find it with outreach_personas_list.
outreach_personas_listList persona records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Personas
List persona records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, description, name, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_personas_get for one record by id. Filters apply to: createdAt, name, updatedAt. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the persona was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The name of the persona (e.g. "Sales Rep"). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the persona was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, updatedAt. Example: -createdAt
outreach_phone_numbers_getGet one phone number in Outreach by its ID.Read-onlyGet Phone Number
Get one phone number in Outreach by its ID. Returns the record's id and attributes (countryCode, createdAt, extension, number, order, phoneType, and more) plus relationship links. Use this when you already have the id. Use outreach_phone_numbers_list to find records. Requires the numeric phone number id.
Inputs
phone_number_idintegerrequired- Numeric Outreach ID of the phone number. Find it with outreach_phone_numbers_list.
outreach_phone_numbers_listList phone number records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Phone Numbers
List phone number records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (countryCode, createdAt, extension, number, order, phoneType, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_phone_numbers_get for one record by id. Filters apply to: number, order, phoneType, status, statusChangedAt, updatedAt, prospect.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_numberstring- Filter by number. The phone number (e.g. +18889387356). (maximum 255 characters.)
filter_orderinteger- Filter by order. Ordered position in list of numbers.
filter_phone_typestring- Filter by phone type. Type of phone (mobile, work, home, voip, and other). (maximum 255 characters.)
filter_prospect_idinteger- Filter by the numeric ID of the related prospect.
filter_statusstring- Filter by status. The status of the number. (maximum 255 characters.)
filter_status_changed_atstring- Filter by status changed at. Time the status was updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_updated_atstring- Filter by updated at. The date and time the phone number was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: number, order, phoneType, status, statusChangedAt, updatedAt. Example: -number
outreach_products_getGet one product in Outreach by its ID.Read-onlyGet Product
Get one product in Outreach by its ID. Returns the record's id and attributes (classification, code, createdAt, custom1, custom2, custom3, and more) plus relationship links. Use this when you already have the id. Use outreach_products_list to find records. Requires the numeric product id.
Inputs
product_idintegerrequired- Numeric Outreach ID of the product. Find it with outreach_products_list.
outreach_products_listList product records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Products
List product records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (classification, code, createdAt, custom1, custom2, custom3, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_products_get for one record by id. Filters apply to: classification, code, createdAt, name, productFamily, status, unitOfMeasure, updatedAt. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_classificationstring- Filter by classification. The Type of Product. Options Include: Own, Competitor, Complimentary. (maximum 255 characters.)
filter_codestring- Filter by code. Unique code of a product. (maximum 255 characters.)
filter_created_atstring- Filter by created at. The date and time the task was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. Name of a product. (maximum 255 characters.)
filter_product_familystring- Filter by product family. Name of Product Family associated with the Product. (maximum 255 characters.)
filter_statusboolean- Filter by status. A boolean value whether the product is active or not.
filter_unit_of_measurestring- Filter by unit of measure. Unit of the product; for example, kilograms, liters, or cases. (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the task was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_websitestring- Filter by website. Website URL of this product. (maximum 255 characters.)
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: code, createdAt, name, updatedAt. Example: -code
outreach_profiles_getGet one profile in Outreach by its ID.Read-onlyGet Profile
Get one profile in Outreach by its ID. Returns the record's id and attributes (createdAt, isAdmin, name, specialId, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_profiles_list to find records. Requires the numeric profile id.
Inputs
profile_idintegerrequired- Numeric Outreach ID of the profile. Find it with outreach_profiles_list.
outreach_profiles_listList profile records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Profiles
List profile records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, isAdmin, name, specialId, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_profiles_get for one record by id. Filters apply to: createdAt, name, specialId, updatedAt. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the team was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The name of the profile (e.g. "Admin"). (maximum 255 characters.)
filter_special_idstring- Filter by special id. The special id flag assigned to the profile (i.e. admin or default). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the team was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, updatedAt. Example: -createdAt
outreach_prospect_notes_getGet one prospect note in Outreach by its ID.Read-onlyGet Prospect Note
Get one prospect note in Outreach by its ID. Returns the record's id and attributes (createdAt, message, noteType, opportunityAssociationRule, pinned) plus relationship links. Use this when you already have the id. Use outreach_prospect_notes_list to find records. Requires the numeric prospect note id.
Inputs
prospect_note_idintegerrequired- Numeric Outreach ID of the prospect note. Find it with outreach_prospect_notes_list.
outreach_prospect_notes_listList notes logged against a prospect in Outreach, with pagination.Read-onlyList Prospect Notes
List notes logged against a prospect in Outreach, with pagination.
Inputs
filter_prospect_idinteger- Filter notes by prospect ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_prospects_getRetrieve a single prospect by ID from Outreach.Read-onlyGet Prospect
Retrieve a single prospect by ID from Outreach.
Inputs
prospect_idintegerrequired- The unique identifier of the prospect to retrieve
outreach_prospects_listList all prospects in Outreach with optional filtering, sorting, and pagination.Read-onlyList Prospects
List all prospects in Outreach with optional filtering, sorting, and pagination.
Inputs
filter_companystring- Filter prospects by company name
filter_emailstring- Filter prospects by email address
filter_first_namestring- Filter prospects by first name
filter_last_namestring- Filter prospects by last name
page_offsetinteger- Offset for pagination (number of records to skip)
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_purchases_getGet one purchase in Outreach by its ID.Read-onlyGet Purchase
Get one purchase in Outreach by its ID. Returns the record's id and attributes (createdAt, currency, custom1, custom2, custom3, custom4, and more) plus relationship links. Use this when you already have the id. Use outreach_purchases_list to find records. Requires the numeric purchase id.
Inputs
purchase_idintegerrequired- Numeric Outreach ID of the purchase. Find it with outreach_purchases_list.
outreach_purchases_listList purchase records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Purchases
List purchase records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, currency, custom1, custom2, custom3, custom4, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_purchases_get for one record by id. Filters apply to: createdAt, currency, endDate, potentialQuantity, potentialValue, saturation, source, startDate. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_account_idinteger- Filter by the numeric ID of the related account.
filter_created_atstring- Filter by created at. The date and time the task was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_currencystring- Filter by currency. It tells you what type of currency we are using to purchase. (maximum 255 characters.)
filter_end_datestring- Filter by end date. End Date of Contract.
filter_owner_idinteger- Filter by the numeric ID of the related owner.
filter_potential_quantitynumber- Filter by potential quantity. Net Potential within an Account.
filter_potential_valuenumber- Filter by potential value. Net Potential Revenue within an Account.
filter_product_idinteger- Filter by the numeric ID of the related product.
filter_saturationnumber- Filter by saturation. Contract seat as a % of potential.
filter_sourcestring- Filter by source. It tells how the purchase record was populated. Either is it manual or some API or some other source. (maximum 255 characters.)
filter_start_datestring- Filter by start date. Start Date of Contract.
filter_statusboolean- Filter by status. A boolean value whether the product is active or not.
filter_total_quantitynumber- Filter by total quantity. Net Contracted Quantity (Always less than or equal to the potential).
filter_total_valuenumber- Filter by total value. Net Current Revenue Sold.
filter_updated_atstring- Filter by updated at. The date and time the task was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, endDate, startDate, updatedAt. Example: -createdAt
outreach_recipients_getGet one recipient in Outreach by its ID.Read-onlyGet Recipient
Get one recipient in Outreach by its ID. Returns the record's id and attributes (createdAt, emailHash, primary, recipientType, updatedAt, value) plus relationship links. Use this when you already have the id. Use outreach_recipients_list to find records. Requires the numeric recipient id.
Inputs
recipient_idintegerrequired- Numeric Outreach ID of the recipient. Find it with outreach_recipients_list.
outreach_recipients_listList recipient records in Outreach, optionally filtered and paged.Read-onlyList Recipients
List recipient records in Outreach, optionally filtered and paged. Returns each record's id and attributes (createdAt, emailHash, primary, recipientType, updatedAt, value) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_recipients_get for one record by id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
outreach_roles_getGet one role in Outreach by its ID.Read-onlyGet Role
Get one role in Outreach by its ID. Returns the record's id and attributes (createdAt, externalId, name, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_roles_list to find records. Requires the numeric role id.
Inputs
role_idintegerrequired- Numeric Outreach ID of the role. Find it with outreach_roles_list.
outreach_roles_listList role records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Roles
List role records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, externalId, name, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_roles_get for one record by id. Filters apply to: createdAt, externalId, name, updatedAt, parentRole.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the team was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_external_idstring- Filter by external id. The permanent, immutable identifier of the role. (maximum 255 characters.)
filter_namestring- Filter by name. The name of the role (e.g. "Vice-President"). (maximum 255 characters.)
filter_parent_role_idinteger- Filter by the numeric ID of the related parent role.
filter_updated_atstring- Filter by updated at. The date and time the team was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, externalId, name, updatedAt. Example: -createdAt
outreach_rulesets_getGet one ruleset in Outreach by its ID.Read-onlyGet Ruleset
Get one ruleset in Outreach by its ID. Returns the record's id and attributes (applyCompletedStageIn, autoResumeOotoProspects, autoResumeOotoProspectsExpiresIn, autoResumeOotoProspectsIn, callOptOutAction, clicksNeededBeforeCallTaskCreated, and more) plus relationship links. Use this when you already have the id. Use outreach_rulesets_list to find records. Requires the numeric ruleset id.
Inputs
ruleset_idintegerrequired- Numeric Outreach ID of the ruleset. Find it with outreach_rulesets_list.
outreach_rulesets_listList ruleset records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Rulesets
List ruleset records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (applyCompletedStageIn, autoResumeOotoProspects, autoResumeOotoProspectsExpiresIn, autoResumeOotoProspectsIn, callOptOutAction, clicksNeededBeforeCallTaskCreated, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_rulesets_get for one record by id. Filters apply to: autoResumeOotoProspects, createdAt, includeUnsubscribeLinks, name, permitDuplicateProspects, sequenceExclusivity, updatedAt, bouncedStage.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_auto_resume_ooto_prospectsboolean- Filter by auto resume ooto prospects. A boolean value whether out-of-the-office Prospects will be automatically resumed. See "autoResumeOotoProspectsIn" and "autoResumeOotoProspectsExpiresIn" for more information.
filter_bounced_stage_idinteger- Filter by the numeric ID of the related bounced stage.
filter_call_task_priority_from_clicks_idinteger- Filter by the numeric ID of the related call task priority from clicks.
filter_call_task_priority_from_opens_idinteger- Filter by the numeric ID of the related call task priority from opens.
filter_call_task_priority_idinteger- Filter by the numeric ID of the related call task priority.
filter_completed_stage_idinteger- Filter by the numeric ID of the related completed stage.
filter_created_atstring- Filter by created at. The date and time the ruleset was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_delivered_stage_idinteger- Filter by the numeric ID of the related delivered stage.
filter_finished_stage_idinteger- Filter by the numeric ID of the related finished stage.
filter_include_unsubscribe_linksboolean- Filter by include unsubscribe links. A boolean value whether to include unsubscribe links within emails.
filter_namestring- Filter by name. The name of the ruleset. (maximum 255 characters.)
filter_opted_out_stage_idinteger- Filter by the numeric ID of the related opted out stage.
filter_owner_idinteger- Filter by the numeric ID of the related owner.
filter_permit_duplicate_prospectsstring- Filter by permit duplicate prospects. A value determining whether a Prospect may be added to this Sequence multiple times or not. Permitted values include "allow", "disallow" (the default) and "only_if_inactive", which indicates that Prospects may be re-added to this sequence if their existing SequenceState is inactive. (maximum 255 characters.)
filter_replied_stage_idinteger- Filter by the numeric ID of the related replied stage.
filter_sequence_exclusivitystring- Filter by sequence exclusivity. A value determining whether Prospects may be added to multiple different Sequences. Permitted values include "all_sequences", "exclusive_sequences" and "none" (the default). If the value is "all_sequences", then Prospects may only be added if they are not active in any other Sequence; likewise, a Prospect active in a Sequence with "all_sequences" exclusivity cannot be added to any other Sequence. If the value is "exclusive_sequences", then Prospects may only be added if they are not active in any other Sequence with "exclusive_sequences" exclusivity; likewise, a Prospect active in a Sequence with "exclusive_sequences" exclusivity cannot be added to any other Sequence with "exclusive_sequences" exclusivity. If the value is "none", then no additional restrictions will be applied. (maximum 255 characters.)
filter_sequences_idinteger- Filter by the numeric ID of the related sequences.
filter_started_stage_idinteger- Filter by the numeric ID of the related started stage.
filter_updated_atstring- Filter by updated at. The date and time the ruleset was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: autoResumeOotoProspects, createdAt, includeUnsubscribeLinks, name, permitDuplicateProspects, sequenceExclusivity, updatedAt. Example: -autoResumeOotoProspects
outreach_sequence_states_getRetrieve a single sequence state (enrollment record) by ID from Outreach.Read-onlyGet Sequence State
Retrieve a single sequence state (enrollment record) by ID from Outreach.
Inputs
sequence_state_idintegerrequired- The unique identifier of the sequence state to retrieve
outreach_sequence_states_listList sequence states (enrollment records) in Outreach, showing which prospects are enrolled in which sequences.Read-onlyList Sequence States
List sequence states (enrollment records) in Outreach, showing which prospects are enrolled in which sequences.
Inputs
filter_prospect_idinteger- Filter by prospect ID
filter_sequence_idinteger- Filter by sequence ID
filter_statestring- Filter by state. Options: active, pending, finished, paused, disabled, failed, bounced, opted_out
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_sequence_steps_getRetrieve a single sequence step by ID from Outreach, including its step order, action type, and associated sequence.Read-onlyGet Sequence Step
Retrieve a single sequence step by ID from Outreach, including its step order, action type, and associated sequence.
Inputs
sequence_step_idintegerrequired- The unique identifier of the sequence step to retrieve
outreach_sequence_steps_listList all sequence steps in Outreach.Read-onlyList Sequence Steps
List all sequence steps in Outreach. Sequence steps define the individual actions (emails, calls, tasks) within a sequence.
Inputs
filter_sequence_idinteger- Filter sequence steps by sequence ID
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_sequence_templates_getGet one sequence template in Outreach by its ID.Read-onlyGet Sequence Template
Get one sequence template in Outreach by its ID. Returns the record's id and attributes (bounceCount, clickCount, createdAt, deliverCount, enabled, enabledAt, and more) plus relationship links. Use this when you already have the id. Use outreach_sequence_templates_list to find records. Requires the numeric sequence template id.
Inputs
sequence_template_idintegerrequired- Numeric Outreach ID of the sequence template. Find it with outreach_sequence_templates_list.
outreach_sequence_templates_listList sequence template records in Outreach, optionally filtered and paged.Read-onlyList Sequence Templates
List sequence template records in Outreach, optionally filtered and paged. Returns each record's id and attributes (bounceCount, clickCount, createdAt, deliverCount, enabled, enabledAt, and more) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_sequence_templates_get for one record by id. Filters apply to: creator.id, template.id, updater.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_creator_idinteger- Filter by the numeric ID of the related creator.
filter_template_idinteger- Filter by the numeric ID of the related template.
filter_updater_idinteger- Filter by the numeric ID of the related updater.
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
outreach_sequences_getRetrieve a single sequence by ID from Outreach.Read-onlyGet Sequence
Retrieve a single sequence by ID from Outreach.
Inputs
sequence_idintegerrequired- The unique identifier of the sequence to retrieve
outreach_sequences_listList all sequences in Outreach with optional filtering and pagination.Read-onlyList Sequences
List all sequences in Outreach with optional filtering and pagination.
Inputs
filter_enabledboolean- Filter by enabled status (true or false)
filter_namestring- Filter sequences by name
page_offsetinteger- Offset for pagination (number of records to skip)
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_snippet_getGet a single reusable email snippet from Outreach by ID.Read-onlyGet Snippet
Get a single reusable email snippet from Outreach by ID.
Inputs
snippet_idintegerrequired- The unique identifier of the snippet to retrieve
outreach_snippets_listList reusable email snippets in Outreach, with optional filtering by name, share type, or owner, and pagination.Read-onlyList Snippets
List reusable email snippets in Outreach, with optional filtering by name, share type, or owner, and pagination.
Inputs
filter_namestring- Filter snippets by name
filter_owner_idinteger- Filter snippets by owner user ID
filter_share_typestring- Filter snippets by share type. One of 'private' or 'shared'
page_offsetinteger- Offset for pagination (number of records to skip)
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order (e.g., '-createdAt')
outreach_stages_getRetrieve a single opportunity stage by ID from Outreach, including its name, color, and order.Read-onlyGet Opportunity Stage
Retrieve a single opportunity stage by ID from Outreach, including its name, color, and order.
Inputs
stage_idintegerrequired- The unique identifier of the opportunity stage to retrieve
outreach_stages_listList all opportunity stages (pipeline stages) configured in Outreach.Read-onlyList Opportunity Stages
List all opportunity stages (pipeline stages) configured in Outreach.
Inputs
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_task_dispositions_getGet one task disposition in Outreach by its ID.Read-onlyGet Task Disposition
Get one task disposition in Outreach by its ID. Returns the record's id and attributes (createdAt, name, order, taskType, updatedAt, value) plus relationship links. Use this when you already have the id. Use outreach_task_dispositions_list to find records. Requires the numeric task disposition id.
Inputs
task_disposition_idintegerrequired- Numeric Outreach ID of the task disposition. Find it with outreach_task_dispositions_list.
outreach_task_dispositions_listList task disposition records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Task Dispositions
List task disposition records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, name, order, taskType, updatedAt, value) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_task_dispositions_get for one record by id. Filters apply to: createdAt, name, order, taskType, updatedAt, value. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the task disposition was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The disposition’s name (e.g. "Initial Contact"). (maximum 255 characters.)
filter_orderinteger- Filter by order. The disposition’s display order within the collection.
filter_task_typestring- Filter by task type. The disposition’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the task disposition was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_valuestring- Filter by value. The disposition’s value. (maximum 255 characters.)
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, order, taskType, updatedAt, value. Example: -createdAt
outreach_task_priorities_getGet one task priority in Outreach by its ID.Read-onlyGet Task Priority
Get one task priority in Outreach by its ID. Returns the record's id and attributes (color, createdAt, name, updatedAt, weight) plus relationship links. Use this when you already have the id. Use outreach_task_priorities_list to find records. Requires the numeric task priority id.
Inputs
task_priority_idintegerrequired- Numeric Outreach ID of the task priority. Find it with outreach_task_priorities_list.
outreach_task_priorities_listList task priority records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Task Priorities
List task priority records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (color, createdAt, name, updatedAt, weight) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_task_priorities_get for one record by id. Filters apply to: createdAt, name, updatedAt, weight. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the task priority was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The name of the task priority (e.g. "High"). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the task priority was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_weightinteger- Filter by weight. A relative value used for display order. Task priorities are listed from lowest to highest weight.
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, updatedAt, weight. Example: -createdAt
outreach_task_purposes_getGet one task purpose in Outreach by its ID.Read-onlyGet Task Purpose
Get one task purpose in Outreach by its ID. Returns the record's id and attributes (createdAt, name, order, taskType, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_task_purposes_list to find records. Requires the numeric task purpose id.
Inputs
task_purpose_idintegerrequired- Numeric Outreach ID of the task purpose. Find it with outreach_task_purposes_list.
outreach_task_purposes_listList task purpose records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Task Purposes
List task purpose records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (createdAt, name, order, taskType, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_task_purposes_get for one record by id. Filters apply to: createdAt, name, order, taskType, updatedAt. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the task purpose was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The purpose’s name (e.g. "Initial Contact"). (maximum 255 characters.)
filter_orderinteger- Filter by order. The purpose’s display order within the collection.
filter_task_typestring- Filter by task type. The purpose’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the task purpose was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, order, taskType, updatedAt. Example: -createdAt
outreach_tasks_getRetrieve a single task by ID from Outreach, including its action type, due date, note, and associated prospect.Read-onlyGet Task
Retrieve a single task by ID from Outreach, including its action type, due date, note, and associated prospect.
Inputs
task_idintegerrequired- The unique identifier of the task to retrieve
outreach_tasks_listList tasks in Outreach with optional filtering by state, action type, prospect, or due date.Read-onlyList Tasks
List tasks in Outreach with optional filtering by state, action type, prospect, or due date.
Inputs
filter_prospect_idinteger- Filter tasks by prospect ID
filter_statestring- Filter tasks by state. Options: incomplete, complete
filter_task_typestring- Filter tasks by task type. Options: action_item, call, email, in_person
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_teams_getGet one team in Outreach by its ID.Read-onlyGet Team
Get one team in Outreach by its ID. Returns the record's id and attributes (color, createdAt, name, scimExternalId, scimSource, updatedAt) plus relationship links. Use this when you already have the id. Use outreach_teams_list to find records. Requires the numeric team id.
Inputs
team_idintegerrequired- Numeric Outreach ID of the team. Find it with outreach_teams_list.
outreach_teams_listList team records in Outreach, optionally filtered, sorted, and paged.Read-onlyList Teams
List team records in Outreach, optionally filtered, sorted, and paged. Returns each record's id and attributes (color, createdAt, name, scimExternalId, scimSource, updatedAt) plus relationship links, with links.next for the next page. Use this to browse or find ids. Use outreach_teams_get for one record by id. Filters apply to: createdAt, name, updatedAt, users.id. Outreach paginates with a cursor: pass page_after from links.next.
Inputs
filter_created_atstring- Filter by created at. The date and time the team was created. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_namestring- Filter by name. The name of the team (e.g. "SDRs"). (maximum 255 characters.)
filter_updated_atstring- Filter by updated at. The date and time the team was last updated. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.) Accepts a single value or a range written from..to (use inf or neginf for an open end).
filter_users_idinteger- Filter by the numeric ID of the related users.
page_afterstring- Cursor for the next page: the opaque page[after] token from links.next in the previous response. Leave empty for the first page.
page_sizeinteger- Number of records to return per page. Outreach returns 50 by default.
sortstring- Field to sort by; prefix with - for descending order. Sortable fields: createdAt, name, updatedAt. Example: -createdAt
outreach_templates_getRetrieve a single email template by ID from Outreach, including its subject, body, and usage statistics.Read-onlyGet Template
Retrieve a single email template by ID from Outreach, including its subject, body, and usage statistics.
Inputs
template_idintegerrequired- The unique identifier of the template to retrieve
outreach_templates_listList email templates in Outreach with optional filtering by name.Read-onlyList Templates
List email templates in Outreach with optional filtering by name.
Inputs
filter_namestring- Filter templates by name
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_users_getRetrieve a single Outreach user by ID, including their name, email, and role information.Read-onlyGet User
Retrieve a single Outreach user by ID, including their name, email, and role information.
Inputs
user_idintegerrequired- The unique identifier of the user to retrieve
outreach_users_listList all users in the Outreach organization with optional filtering and pagination.Read-onlyList Users
List all users in the Outreach organization with optional filtering and pagination.
Inputs
filter_emailstring- Filter users by email address
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
sortstring- Sort field. Prefix with '-' for descending order
outreach_webhooks_getRetrieve a single webhook configuration by ID from Outreach.Read-onlyGet Webhook
Retrieve a single webhook configuration by ID from Outreach.
Inputs
webhook_idintegerrequired- The unique identifier of the webhook to retrieve
outreach_webhooks_listList all webhooks configured in Outreach for receiving event notifications.Read-onlyList Webhooks
List all webhooks configured in Outreach for receiving event notifications.
Inputs
page_offsetinteger- Offset for pagination
page_sizeinteger- Number of results per page (max 1000)
outreach_account_note_createAdd a note to an account in Outreach, e.g.WriteCreate Account Note
Add a note to an account in Outreach, e.g. to log a meeting, call, or general observation.
Inputs
account_idintegerrequired- ID of the account to attach this note to
messagestringrequired- Text content of the note
note_typestring- Context of the note. One of 'note', 'call', 'coffee', 'beer', 'meeting'
opportunity_idinteger- ID of an opportunity to associate this note with
pinnedboolean- Whether to pin this note to the top of the account's note list
outreach_account_notes_updateUpdate an existing account note in Outreach.WriteUpdate Account Note
Update an existing account note in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_account_notes_get to read the current values. Requires the account note id.
- Idempotent
Inputs
account_note_idintegerrequired- Numeric Outreach ID of the account note. Find it with outreach_account_notes_list.
account_idinteger- The account this account note is related to. Provide the numeric Outreach ID.
messagestring- The text content of this account note. (maximum 65535 characters.)
note_typestring- The context of this account note, one of {note,call,coffee,beer,meeting}. (maximum 255 characters.)
opportunity_association_rulestring- The rule used to associate the account note with an opportunity, one of {recent_created,recent_updated}. (maximum 255 characters.)
pinnedboolean- A boolean value indicating whether this account note is pinned.
outreach_accounts_createCreate a new account (company) in Outreach.WriteCreate Account
Create a new account (company) in Outreach.
Inputs
namestringrequired- Name of the account (company)
descriptionstring- Description of the account
domainstring- Website domain of the account
industrystring- Industry of the account
linkedin_urlstring- LinkedIn company page URL
localitystring- Location/city of the account
number_of_employeesinteger- Number of employees at the account
owner_idinteger- ID of the user (owner) to assign this account to
tagsarray- Array of tags to apply to the account
website_urlstring- Website URL of the account
outreach_accounts_updateUpdate an existing account in Outreach.WriteUpdate Account
Update an existing account in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
account_idintegerrequired- The unique identifier of the account to update
descriptionstring- Updated description of the account
domainstring- Updated website domain
industrystring- Updated industry of the account
namestring- Updated name of the account
number_of_employeesinteger- Updated number of employees
owner_idinteger- Updated owner user ID
tagsarray- Updated array of tags
website_urlstring- Updated website URL
outreach_batch_cancelCancel an Outreach batch (a bulk job) by its ID.WriteCancel Batch
Cancel an Outreach batch (a bulk job) by its ID. Returns the batch with its updated state. Use this to abort a batch you no longer want to run; use outreach_batch_confirm to proceed with one that is waiting for confirmation, and outreach_batches_get to check its state. Requires the batch id from outreach_batches_list.
Inputs
batch_idintegerrequired- Numeric Outreach ID of the batch. Find it with outreach_batches_list.
outreach_batch_confirmConfirm an Outreach batch (a bulk job) that is waiting for confirmation so it can proceed.WriteConfirm Batch
Confirm an Outreach batch (a bulk job) that is waiting for confirmation so it can proceed. Returns the batch with its updated state. Use this after a bulk operation was started without skipping confirmation; use outreach_batch_cancel to abort it instead. Requires the batch id. If the batch has confirmedCountRequired set to true, pass confirmed_count equal to the batch's confirmCount.
Inputs
batch_idintegerrequired- Numeric Outreach ID of the batch. Find it with outreach_batches_list.
confirmed_countinteger- The confirmed count for this action.
outreach_call_dispositions_createCreate a new call disposition in Outreach.WriteCreate Call Disposition
Create a new call disposition in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_call_dispositions_update to change one later and use outreach_call_dispositions_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
namestring- The disposition’s name (e.g. "Meeting Scheduled"). (maximum 255 characters.)
orderinteger- The disposition’s display order within the collection.
outcomestring- The disposition’s call outcome; must be either "Answered" or "Not Answered". (maximum 255 characters.)
outreach_call_dispositions_updateUpdate an existing call disposition in Outreach.WriteUpdate Call Disposition
Update an existing call disposition in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_call_dispositions_create to make a new one, and use outreach_call_dispositions_get to read the current values. Requires the call disposition id.
- Idempotent
Inputs
call_disposition_idintegerrequired- Numeric Outreach ID of the call disposition. Find it with outreach_call_dispositions_list.
namestring- The disposition’s name (e.g. "Meeting Scheduled"). (maximum 255 characters.)
orderinteger- The disposition’s display order within the collection.
outcomestring- The disposition’s call outcome; must be either "Answered" or "Not Answered". (maximum 255 characters.)
outreach_call_purposes_createCreate a new call purpose in Outreach.WriteCreate Call Purpose
Create a new call purpose in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_call_purposes_update to change one later and use outreach_call_purposes_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
namestring- The purpose’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The purpose’s display order within the collection.
outreach_call_purposes_updateUpdate an existing call purpose in Outreach.WriteUpdate Call Purpose
Update an existing call purpose in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_call_purposes_create to make a new one, and use outreach_call_purposes_get to read the current values. Requires the call purpose id.
- Idempotent
Inputs
call_purpose_idintegerrequired- Numeric Outreach ID of the call purpose. Find it with outreach_call_purposes_list.
namestring- The purpose’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The purpose’s display order within the collection.
outreach_calls_createLog a call record in Outreach.WriteCreate Call
Log a call record in Outreach. Used to track inbound or outbound call activity against a prospect.
Inputs
answered_atstring- ISO 8601 datetime when the call was answered
call_disposition_idinteger- ID of the call disposition (outcome category)
call_purpose_idinteger- ID of the call purpose
directionstring- Direction of the call. Options: inbound, outbound
durationinteger- Duration of the call in seconds
notestring- Note or summary about the call
outcomestring- Outcome of the call (e.g., connected, no_answer, left_voicemail)
prospect_idinteger- ID of the prospect associated with this call
outreach_content_categories_createCreate a new content category in Outreach.WriteCreate Content Category
Create a new content category in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_content_categories_update to change one later and use outreach_content_categories_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
allow_sequencesboolean- Can this category be used to group sequences?.
allow_snippetsboolean- Can this category be used to group snippets?.
allow_templatesboolean- Can this category be used to group templates?.
colorstring- Color of the content category to be used as a background. (maximum 255 characters.)
namestring- The name of the content category. (maximum 255 characters.)
outreach_content_categories_updateUpdate an existing content category in Outreach.WriteUpdate Content Category
Update an existing content category in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_content_categories_create to make a new one, and use outreach_content_categories_get to read the current values. Requires the content category id.
- Idempotent
Inputs
content_category_idintegerrequired- Numeric Outreach ID of the content category. Find it with outreach_content_categories_list.
allow_sequencesboolean- Can this category be used to group sequences?.
allow_snippetsboolean- Can this category be used to group snippets?.
allow_templatesboolean- Can this category be used to group templates?.
colorstring- Color of the content category to be used as a background. (maximum 255 characters.)
namestring- The name of the content category. (maximum 255 characters.)
outreach_content_category_memberships_createCreate a new content category membership in Outreach.WriteCreate Content Category Membership
Create a new content category membership in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_content_category_memberships_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
content_category_idinteger- The content category the record is part of. Provide the numeric Outreach ID.
content_idinteger- The record in the content category. Must be a sequence, snippet, or template. Provide the numeric Outreach ID.
outreach_content_category_ownerships_createCreate a new content category ownership in Outreach.WriteCreate Content Category Ownership
Create a new content category ownership in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_content_category_ownerships_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
content_category_idinteger- The content category the owner is linked to. Provide the numeric Outreach ID.
owner_idinteger- The record the content category is tied to. Must a team for now. Provide the numeric Outreach ID.
outreach_email_address_createAdd a new email address to an existing prospect in Outreach.WriteCreate Email Address
Add a new email address to an existing prospect in Outreach.
Inputs
emailstringrequired- The raw email address value
prospect_idintegerrequired- ID of the prospect that owns this email address
email_typestring- Type of email address, e.g. 'work' or 'personal'
orderinteger- Ordered position of this email address in the prospect's list of emails
outreach_email_address_updateUpdate an existing prospect email address in Outreach.WriteUpdate Email Address
Update an existing prospect email address in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
email_address_idintegerrequired- The unique identifier of the email address to update
emailstring- Updated raw email address value
email_typestring- Updated type of email address, e.g. 'work' or 'personal'
orderinteger- Updated ordered position of this email address
statusstring- Updated status of the email address
outreach_favorites_createCreate a new favorite in Outreach.WriteCreate Favorite
Create a new favorite in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_favorites_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
user_idinteger- The user who's favorite this is. Provide the numeric Outreach ID.
outreach_mailbox_link_ews_master_accountLink an Outreach mailbox with an EWS (Exchange Web Services) master account.WriteLink Ews Master Account Mailbox
Link an Outreach mailbox with an EWS (Exchange Web Services) master account. Returns an empty response when the mailbox is linked. Use this to connect a mailbox to an EWS master account; use outreach_mailbox_unlink_ews_master_account to remove the link. Requires the mailbox id from outreach_mailboxes_list.
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
outreach_mailbox_test_sendTest whether sending email works from an Outreach mailbox.WriteTest Send Mailbox
Test whether sending email works from an Outreach mailbox. Returns the mailbox record after the test. Use this to diagnose a mailbox that is not delivering; use outreach_mailbox_test_sync to test syncing instead. Requires the mailbox id from outreach_mailboxes_list.
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
outreach_mailbox_test_syncTest whether syncing email works from an Outreach mailbox.WriteTest Sync Mailbox
Test whether syncing email works from an Outreach mailbox. Returns the mailbox record after the test. Use this to diagnose a mailbox that is not syncing; use outreach_mailbox_test_send to test sending instead. Requires the mailbox id from outreach_mailboxes_list.
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
outreach_mailboxes_createCreate a new mailbox in Outreach.WriteCreate Mailbox
Create a new mailbox in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_mailboxes_update to change one later and use outreach_mailboxes_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
auth_idinteger- The auth id associated with the mailbox.
emailstring- The email address of the mailbox. (maximum 255 characters.)
email_hashstring- Hashed email address of the mailbox. (maximum 255 characters.)
email_providerstring- The mail service provider. While not a required field, it is strongly recommended to use one of 'exchange_online', 'exchange_server', 'gmail', 'gmail_api', 'google_oauth2', 'intermedia', 'office365_oauth2', 'microsoft_hma_oauth2', 'office_365', 'rackspace'. If no value is provided, send and sync will make assumptions based on the ews, imap, and smtp values provided. (maximum 255 characters.)
email_signaturestring- The default signature, in HTML, to be appended to sent email messages. (maximum 65535 characters.)
ews_endpointstring- The url of the Exchange Web Service. (maximum 255 characters.)
ews_ssl_verify_modeinteger- The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify client once=4, verify fail if no peer cert=2).
exchange_versionstring- The version of Exchange. Must be one of 'Exchange2007', 'Exchange2007_SP1', 'Exchange2010', 'Exchange2010_SP1', 'Exchange2010_SP2', 'Exchange2013', 'Exchange2013_SP1'. (maximum 255 characters.)
imap_hoststring- The address of the IMAP host, used for syncing (e.g. 'imap.gmail.com'). (maximum 255 characters.)
imap_portinteger- The port number the IMAP server is using (e.g. '993').
imap_sslboolean- A boolean value whether the IMAP connection will use SSL.
max_emails_per_dayinteger- The maximum number of in/out emails per day.
max_mailings_per_dayinteger- The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500.
max_mailings_per_weekinteger- The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000.
opt_out_messagestring- The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email (e.g. "To unsubscribe, click the button below."). (maximum 512 characters.)
opt_out_signaturestring- The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. "If you'd like me to stop sending you emails, please ` click here `"). (maximum 512 characters.)
passwordstring- The password of the mailbox. This attribute can be used to set the password, but is not available for read. (maximum 65535 characters.)
prospect_email_exclusionsstring- A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. "`*@outreach.io daniel@example.com`"). (maximum 65535 characters.)
send_disabledboolean- A boolean value whether sending is disabled from this mailbox.
send_max_retriesinteger- The maximum number of times to auto-retry a delivery when it fails.
send_methodstring- The method used for sending email. Must be either 'ews', 'sendgrid', or 'smtp'. (maximum 255 characters.)
send_periodinteger- The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries per minute (sendPeriod is 60).
send_requires_syncboolean- A boolean value whether the mailbox is required to be recently synced before sending.
send_thresholdinteger- The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute (sendThreshold is 2).
sendgrid_api_keystring- The api key of the SendGrid account used for sending. (maximum 65535 characters.)
smtp_hoststring- The address of the SMTP host, used for sending (e.g. 'smtp.gmail.com'). (maximum 255 characters.)
smtp_passwordstring- The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). (maximum 65535 characters.)
smtp_portinteger- The port number the SMTP server is using (e.g. '587').
smtp_sslboolean- A boolean value whether the SMTP connection will use SSL.
smtp_usernamestring- The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). (maximum 255 characters.)
sync_active_frequencyinteger- The amount of time in seconds between syncing when the user is actively using the application.
sync_disabledboolean- A boolean value whether syncing is disabled from this mailbox.
sync_methodstring- The method used for syncing email. Must be either 'ews', 'gmail_api', or 'imap'. (maximum 255 characters.)
sync_outreach_folderboolean- A boolean value whether the folder for syncing is named 'Outreach' instead of 'Inbox'. Only available for Exchange version 'Exchange2007_SP1'.
sync_passive_frequencyinteger- The amount of time in seconds between syncing when the user is not actively using the application.
user_idinteger- The user owning this mailbox. Provide the numeric Outreach ID.
usernamestring- The username of the email account. While not a required field, a username is necessary for most email providers outside of OAuth. This value is normally the same as the email address. (maximum 255 characters.)
validate_sendboolean- If this is set to true then the record will only save successfully if the mailbox is properly configured to send emails.
validate_syncboolean- If this is set to true then the record will only save successfully if the mailbox is properly configured to sync emails.
outreach_mailboxes_updateUpdate an existing mailbox in Outreach.WriteUpdate Mailbox
Update an existing mailbox in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_mailboxes_create to make a new one, and use outreach_mailboxes_get to read the current values. Requires the mailbox id.
- Idempotent
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
auth_idinteger- The auth id associated with the mailbox.
emailstring- The email address of the mailbox. (maximum 255 characters.)
email_hashstring- Hashed email address of the mailbox. (maximum 255 characters.)
email_providerstring- The mail service provider. While not a required field, it is strongly recommended to use one of 'exchange_online', 'exchange_server', 'gmail', 'gmail_api', 'google_oauth2', 'intermedia', 'office365_oauth2', 'microsoft_hma_oauth2', 'office_365', 'rackspace'. If no value is provided, send and sync will make assumptions based on the ews, imap, and smtp values provided. (maximum 255 characters.)
email_signaturestring- The default signature, in HTML, to be appended to sent email messages. (maximum 65535 characters.)
ews_endpointstring- The url of the Exchange Web Service. (maximum 255 characters.)
ews_ssl_verify_modeinteger- The SSL verify mode, represented as an integer, the EWS connection will used. (verify none=0, verify peer=1, verify client once=4, verify fail if no peer cert=2).
exchange_versionstring- The version of Exchange. Must be one of 'Exchange2007', 'Exchange2007_SP1', 'Exchange2010', 'Exchange2010_SP1', 'Exchange2010_SP2', 'Exchange2013', 'Exchange2013_SP1'. (maximum 255 characters.)
imap_hoststring- The address of the IMAP host, used for syncing (e.g. 'imap.gmail.com'). (maximum 255 characters.)
imap_portinteger- The port number the IMAP server is using (e.g. '993').
imap_sslboolean- A boolean value whether the IMAP connection will use SSL.
max_emails_per_dayinteger- The maximum number of in/out emails per day.
max_mailings_per_dayinteger- The maximum number of emails the application can send in a day from this mailbox. Recommended value is 500.
max_mailings_per_weekinteger- The maximum number of emails the application can send within a week from this mailbox. Recommended value is 5000.
opt_out_messagestring- The message displayed on the unsubscribe confirmation page, seen after clicking the unsubscribe link in the email (e.g. "To unsubscribe, click the button below."). (maximum 512 characters.)
opt_out_signaturestring- The message below the signature, in HTML, when the sequence requires an unsubscribe link (e.g. "If you'd like me to stop sending you emails, please ` click here `"). (maximum 512 characters.)
passwordstring- The password of the mailbox. This attribute can be used to set the password, but is not available for read. (maximum 65535 characters.)
prospect_email_exclusionsstring- A list (provided as a string, newline-delimited) of email address patterns to be excluded from syncing (e.g. "`*@outreach.io daniel@example.com`"). (maximum 65535 characters.)
send_disabledboolean- A boolean value whether sending is disabled from this mailbox.
send_max_retriesinteger- The maximum number of times to auto-retry a delivery when it fails.
send_methodstring- The method used for sending email. Must be either 'ews', 'sendgrid', or 'smtp'. (maximum 255 characters.)
send_periodinteger- The amount of time in seconds that the number of sendThreshold emails can be sent. Recommended value is two deliveries per minute (sendPeriod is 60).
send_requires_syncboolean- A boolean value whether the mailbox is required to be recently synced before sending.
send_thresholdinteger- The maximum number of email sends per the sendPeriod amount of time. Recommended value is two deliveries per minute (sendThreshold is 2).
sendgrid_api_keystring- The api key of the SendGrid account used for sending. (maximum 65535 characters.)
smtp_hoststring- The address of the SMTP host, used for sending (e.g. 'smtp.gmail.com'). (maximum 255 characters.)
smtp_passwordstring- The password for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). (maximum 65535 characters.)
smtp_portinteger- The port number the SMTP server is using (e.g. '587').
smtp_sslboolean- A boolean value whether the SMTP connection will use SSL.
smtp_usernamestring- The username for the SMTP account. This value should be left blank unless a separate SMTP account is being used for sending (i.e. not the mailbox's main username/password). (maximum 255 characters.)
sync_active_frequencyinteger- The amount of time in seconds between syncing when the user is actively using the application.
sync_disabledboolean- A boolean value whether syncing is disabled from this mailbox.
sync_methodstring- The method used for syncing email. Must be either 'ews', 'gmail_api', or 'imap'. (maximum 255 characters.)
sync_outreach_folderboolean- A boolean value whether the folder for syncing is named 'Outreach' instead of 'Inbox'. Only available for Exchange version 'Exchange2007_SP1'.
sync_passive_frequencyinteger- The amount of time in seconds between syncing when the user is not actively using the application.
user_idinteger- The user owning this mailbox. Provide the numeric Outreach ID.
usernamestring- The username of the email account. While not a required field, a username is necessary for most email providers outside of OAuth. This value is normally the same as the email address. (maximum 255 characters.)
validate_sendboolean- If this is set to true then the record will only save successfully if the mailbox is properly configured to send emails.
validate_syncboolean- If this is set to true then the record will only save successfully if the mailbox is properly configured to sync emails.
outreach_mailings_createCreate a new mailing in Outreach.WriteCreate Mailing
Create a new mailing in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_mailings_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
body_htmlstring- The mailing's custom email body, represented in HTML. If provided this field will override any associated template.
follow_up_sequence_idinteger- The followup sequence associated with this mailing. Provide the numeric Outreach ID.
follow_up_task_scheduled_atstring- The date and time of when a follow-up task should be due for this mailing. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.)
follow_up_task_typestring- The type of follow-up task to create. Possible values are 'follow_up' or 'no_reply'. (maximum 255 characters.)
mailbox_idinteger- The mailbox associated with this mailing. Provide the numeric Outreach ID.
prospect_idinteger- The prospect associated with this mailing. Provide the numeric Outreach ID.
recipients_idsarray- Recipients of the mailing. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
scheduled_atstring- The date and time the email is scheduled to send. (ISO 8601 date-time, for example 2025-01-31T09:00:00Z.)
statestring- The current state of the mailing. Can be 'bounced', 'delivered', 'delivering', 'drafted', 'failed', 'opened', 'placeholder', 'queued', 'replied', or 'scheduled'. (maximum 255 characters.)
subjectstring- The subject line of the email.
task_idinteger- The task this mailing will or did complete upon sending. Provide the numeric Outreach ID.
template_idinteger- The template associated with this mailing. Provide the numeric Outreach ID.
track_linksboolean- A boolean value whether the mailing is tracking link clicks.
track_opensboolean- A boolean value whether the mailing is tracking email opens.
outreach_opportunities_createCreate a new opportunity in Outreach to track sales deals.WriteCreate Opportunity
Create a new opportunity in Outreach to track sales deals.
Inputs
close_datestringrequired- Expected close date for the opportunity in full ISO 8601 datetime format (YYYY-MM-DDTHH:MM:SS.000Z)
namestringrequired- Name or title of the opportunity
account_idinteger- ID of the account associated with this opportunity
amountnumber- Monetary value of the opportunity
owner_idinteger- ID of the user (owner) responsible for this opportunity
probabilityinteger- Probability of closing (0-100)
prospect_idinteger- ID of the prospect (primary contact) associated with this opportunity
stage_idinteger- ID of the opportunity stage
outreach_opportunities_updateUpdate an existing opportunity in Outreach.WriteUpdate Opportunity
Update an existing opportunity in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
opportunity_idintegerrequired- The unique identifier of the opportunity to update
amountnumber- Updated monetary value of the opportunity
close_datestring- Updated expected close date (ISO 8601 format)
namestring- Updated name of the opportunity
owner_idinteger- Updated owner user ID
probabilityinteger- Updated probability of closing (0-100)
stage_idinteger- Updated opportunity stage ID
outreach_opportunity_prospect_roles_createCreate a new opportunity prospect role in Outreach.WriteCreate Opportunity Prospect Role
Create a new opportunity prospect role in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_opportunity_prospect_roles_update to change one later and use outreach_opportunity_prospect_roles_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
opportunity_idinteger- The opportunity associated with the role. Provide the numeric Outreach ID.
primaryboolean- A boolean value indicating if this prospect is the primary contact within an opportunity.
prospect_idinteger- The prospect associated with the role. Provide the numeric Outreach ID.
rolestring- A string value representing the role. (maximum 255 characters.)
outreach_opportunity_prospect_roles_updateUpdate an existing opportunity prospect role in Outreach.WriteUpdate Opportunity Prospect Role
Update an existing opportunity prospect role in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_opportunity_prospect_roles_create to make a new one, and use outreach_opportunity_prospect_roles_get to read the current values. Requires the opportunity prospect role id.
- Idempotent
Inputs
opportunity_prospect_role_idintegerrequired- Numeric Outreach ID of the opportunity prospect role. Find it with outreach_opportunity_prospect_roles_list.
opportunity_idinteger- The opportunity associated with the role. Provide the numeric Outreach ID.
primaryboolean- A boolean value indicating if this prospect is the primary contact within an opportunity.
prospect_idinteger- The prospect associated with the role. Provide the numeric Outreach ID.
rolestring- A string value representing the role. (maximum 255 characters.)
outreach_opportunity_stages_createCreate a new opportunity stage in Outreach.WriteCreate Opportunity Stage
Create a new opportunity stage in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_opportunity_stages_update to change one later. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
colorstring- The color used to label and highlight the opportunity stage. (maximum 255 characters.)
is_closedboolean- Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity.
namestring- The name of the opportunity stage. (maximum 255 characters.)
orderinteger- The order of the opportunity stage.
outreach_opportunity_stages_updateUpdate an existing opportunity stage in Outreach.WriteUpdate Opportunity Stage
Update an existing opportunity stage in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_opportunity_stages_create to make a new one. Requires the opportunity stage id.
- Idempotent
Inputs
opportunity_stage_idintegerrequired- Numeric Outreach ID of the opportunity stage.
colorstring- The color used to label and highlight the opportunity stage. (maximum 255 characters.)
is_closedboolean- Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity.
namestring- The name of the opportunity stage. (maximum 255 characters.)
orderinteger- The order of the opportunity stage.
outreach_org_settings_updateUpdate an existing org setting in Outreach.WriteUpdate Org Setting
Update an existing org setting in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_org_settings_get to read the current values. Requires the org setting id.
- Idempotent
Inputs
org_setting_idstringrequired- ID of the org setting (a UUID in Outreach's API reference).
contact_exclusionsstring- Comma separated list of contact email addresses that are blocked. (maximum 65535 characters.)
prospect_email_exclusionsstring- Comma separated list of prospect email addresses blocked. (maximum 65535 characters.)
send_exclusionsstring- Comma separated list of email addresses that are blocked. (maximum 65535 characters.)
outreach_personas_createCreate a new persona in Outreach.WriteCreate Persona
Create a new persona in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_personas_update to change one later and use outreach_personas_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
descriptionstring- A description of the persona. (maximum 255 characters.)
namestring- The name of the persona (e.g. "Sales Rep"). (maximum 255 characters.)
outreach_personas_updateUpdate an existing persona in Outreach.WriteUpdate Persona
Update an existing persona in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_personas_create to make a new one, and use outreach_personas_get to read the current values. Requires the persona id.
- Idempotent
Inputs
persona_idintegerrequired- Numeric Outreach ID of the persona. Find it with outreach_personas_list.
descriptionstring- A description of the persona. (maximum 255 characters.)
namestring- The name of the persona (e.g. "Sales Rep"). (maximum 255 characters.)
outreach_phone_numbers_createCreate a new phone number in Outreach.WriteCreate Phone Number
Create a new phone number in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_phone_numbers_update to change one later and use outreach_phone_numbers_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
country_codestring- The country code (e.g. US). (maximum 255 characters.)
extensionstring- Phone number extension (e.g. 123). (maximum 255 characters.)
numberstring- The phone number (e.g. +18889387356). (maximum 255 characters.)
orderinteger- Ordered position in list of numbers.
phone_typestring- Type of phone (mobile, work, home, voip, and other). (maximum 255 characters.)
prospect_idinteger- Provide the numeric Outreach ID.
raw_numberstring- Unformatted phone number. (maximum 255 characters.)
statusstring- The status of the number. (maximum 255 characters.)
outreach_phone_numbers_updateUpdate an existing phone number in Outreach.WriteUpdate Phone Number
Update an existing phone number in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_phone_numbers_create to make a new one, and use outreach_phone_numbers_get to read the current values. Requires the phone number id.
- Idempotent
Inputs
phone_number_idintegerrequired- Numeric Outreach ID of the phone number. Find it with outreach_phone_numbers_list.
country_codestring- The country code (e.g. US). (maximum 255 characters.)
extensionstring- Phone number extension (e.g. 123). (maximum 255 characters.)
numberstring- The phone number (e.g. +18889387356). (maximum 255 characters.)
orderinteger- Ordered position in list of numbers.
phone_typestring- Type of phone (mobile, work, home, voip, and other). (maximum 255 characters.)
prospect_idinteger- Provide the numeric Outreach ID.
raw_numberstring- Unformatted phone number. (maximum 255 characters.)
statusstring- The status of the number. (maximum 255 characters.)
outreach_products_createCreate a new product in Outreach.WriteCreate Product
Create a new product in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_products_update to change one later and use outreach_products_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
classificationstring- The Type of Product. Options Include: Own, Competitor, Complimentary. (maximum 255 characters.)
codestring- Unique code of a product. (maximum 255 characters.)
custom1string- The value of the product's first custom field.
custom10string- The value of the product's 10th custom field.
custom100string- The value of the product's 100th custom field.
custom101string- The value of the product's 101st custom field.
custom102string- The value of the product's 102nd custom field.
custom103string- The value of the product's 103rd custom field.
custom104string- The value of the product's 104th custom field.
custom105string- The value of the product's 105th custom field.
custom106string- The value of the product's 106th custom field.
custom107string- The value of the product's 107th custom field.
custom108string- The value of the product's 108th custom field.
custom109string- The value of the product's 109th custom field.
custom11string- The value of the product's 11th custom field.
custom110string- The value of the product's 110th custom field.
custom111string- The value of the product's 111th custom field.
custom112string- The value of the product's 112th custom field.
custom113string- The value of the product's 113th custom field.
custom114string- The value of the product's 114th custom field.
custom115string- The value of the product's 115th custom field.
custom116string- The value of the product's 116th custom field.
custom117string- The value of the product's 117th custom field.
custom118string- The value of the product's 118th custom field.
custom119string- The value of the product's 119th custom field.
custom12string- The value of the product's 12th custom field.
custom120string- The value of the product's 120th custom field.
custom121string- The value of the product's 121st custom field.
custom122string- The value of the product's 122nd custom field.
custom123string- The value of the product's 123rd custom field.
custom124string- The value of the product's 124th custom field.
custom125string- The value of the product's 125th custom field.
custom126string- The value of the product's 126th custom field.
custom127string- The value of the product's 127th custom field.
custom128string- The value of the product's 128th custom field.
custom129string- The value of the product's 129th custom field.
custom13string- The value of the product's 13th custom field.
custom130string- The value of the product's 130th custom field.
custom131string- The value of the product's 131st custom field.
custom132string- The value of the product's 132nd custom field.
custom133string- The value of the product's 133rd custom field.
custom134string- The value of the product's 134th custom field.
custom135string- The value of the product's 135th custom field.
custom136string- The value of the product's 136th custom field.
custom137string- The value of the product's 137th custom field.
custom138string- The value of the product's 138th custom field.
custom139string- The value of the product's 139th custom field.
custom14string- The value of the product's 14th custom field.
custom140string- The value of the product's 140th custom field.
custom141string- The value of the product's 141st custom field.
custom142string- The value of the product's 142nd custom field.
custom143string- The value of the product's 143rd custom field.
custom144string- The value of the product's 144th custom field.
custom145string- The value of the product's 145th custom field.
custom146string- The value of the product's 146th custom field.
custom147string- The value of the product's 147th custom field.
custom148string- The value of the product's 148th custom field.
custom149string- The value of the product's 149th custom field.
custom15string- The value of the product's 15th custom field.
custom150string- The value of the product's 150th custom field.
custom16string- The value of the product's 16th custom field.
custom17string- The value of the product's 17th custom field.
custom18string- The value of the product's 18th custom field.
custom19string- The value of the product's 19th custom field.
custom2string- The value of the product's second custom field.
custom20string- The value of the product's 20th custom field.
custom21string- The value of the product's 21st custom field.
custom22string- The value of the product's 22nd custom field.
custom23string- The value of the product's 23rd custom field.
custom24string- The value of the product's 24th custom field.
custom25string- The value of the product's 25th custom field.
custom26string- The value of the product's 26th custom field.
custom27string- The value of the product's 27th custom field.
custom28string- The value of the product's 28th custom field.
custom29string- The value of the product's 29th custom field.
custom3string- The value of the product's third custom field.
custom30string- The value of the product's 30th custom field.
custom31string- The value of the product's 31st custom field.
custom32string- The value of the product's 32nd custom field.
custom33string- The value of the product's 33rd custom field.
custom34string- The value of the product's 34th custom field.
custom35string- The value of the product's 35th custom field.
custom36string- The value of the product's 36th custom field.
custom37string- The value of the product's 37th custom field.
custom38string- The value of the product's 38th custom field.
custom39string- The value of the product's 39th custom field.
custom4string- The value of the product's fourth custom field.
custom40string- The value of the product's 40th custom field.
custom41string- The value of the product's 41st custom field.
custom42string- The value of the product's 42nd custom field.
custom43string- The value of the product's 43rd custom field.
custom44string- The value of the product's 44th custom field.
custom45string- The value of the product's 45th custom field.
custom46string- The value of the product's 46th custom field.
custom47string- The value of the product's 47th custom field.
custom48string- The value of the product's 48th custom field.
custom49string- The value of the product's 49th custom field.
custom5string- The value of the product's fifth custom field.
custom50string- The value of the product's 50th custom field.
custom51string- The value of the product's 51st custom field.
custom52string- The value of the product's 52nd custom field.
custom53string- The value of the product's 53rd custom field.
custom54string- The value of the product's 54th custom field.
custom55string- The value of the product's 55th custom field.
custom56string- The value of the product's 56th custom field.
custom57string- The value of the product's 57th custom field.
custom58string- The value of the product's 58th custom field.
custom59string- The value of the product's 59th custom field.
custom6string- The value of the product's sixth custom field.
custom60string- The value of the product's 60th custom field.
custom61string- The value of the product's 61st custom field.
custom62string- The value of the product's 62nd custom field.
custom63string- The value of the product's 63rd custom field.
custom64string- The value of the product's 64th custom field.
custom65string- The value of the product's 65th custom field.
custom66string- The value of the product's 66th custom field.
custom67string- The value of the product's 67th custom field.
custom68string- The value of the product's 68th custom field.
custom69string- The value of the product's 69th custom field.
custom7string- The value of the product's seventh custom field.
custom70string- The value of the product's 70th custom field.
custom71string- The value of the product's 71st custom field.
custom72string- The value of the product's 72nd custom field.
custom73string- The value of the product's 73rd custom field.
custom74string- The value of the product's 74th custom field.
custom75string- The value of the product's 75th custom field.
custom76string- The value of the product's 76th custom field.
custom77string- The value of the product's 77th custom field.
custom78string- The value of the product's 78th custom field.
custom79string- The value of the product's 79th custom field.
custom8string- The value of the product's eight custom field.
custom80string- The value of the product's 80th custom field.
custom81string- The value of the product's 81st custom field.
custom82string- The value of the product's 82nd custom field.
custom83string- The value of the product's 83rd custom field.
custom84string- The value of the product's 84th custom field.
custom85string- The value of the product's 85th custom field.
custom86string- The value of the product's 86th custom field.
custom87string- The value of the product's 87th custom field.
custom88string- The value of the product's 88th custom field.
custom89string- The value of the product's 89th custom field.
custom9string- The value of the product's ninth custom field.
custom90string- The value of the product's 90th custom field.
custom91string- The value of the product's 91st custom field.
custom92string- The value of the product's 92nd custom field.
custom93string- The value of the product's 93rd custom field.
custom94string- The value of the product's 94th custom field.
custom95string- The value of the product's 95th custom field.
custom96string- The value of the product's 96th custom field.
custom97string- The value of the product's 97th custom field.
custom98string- The value of the product's 98th custom field.
custom99string- The value of the product's 99th custom field.
deletedboolean- A boolean value whether the product has deleted or not.
descriptionstring- A custom description of the product. (maximum 16777215 characters.)
namestring- Name of a product. (maximum 255 characters.)
owner_idinteger- The owner of this task. Provide the numeric Outreach ID.
product_familystring- Name of Product Family associated with the Product. (maximum 255 characters.)
statusboolean- A boolean value whether the product is active or not.
unit_of_measurestring- Unit of the product; for example, kilograms, liters, or cases. (maximum 255 characters.)
websitestring- Website URL of this product. (maximum 255 characters.)
outreach_products_updateUpdate an existing product in Outreach.WriteUpdate Product
Update an existing product in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_products_create to make a new one, and use outreach_products_get to read the current values. Requires the product id.
- Idempotent
Inputs
product_idintegerrequired- Numeric Outreach ID of the product. Find it with outreach_products_list.
classificationstring- The Type of Product. Options Include: Own, Competitor, Complimentary. (maximum 255 characters.)
codestring- Unique code of a product. (maximum 255 characters.)
custom1string- The value of the product's first custom field.
custom10string- The value of the product's 10th custom field.
custom100string- The value of the product's 100th custom field.
custom101string- The value of the product's 101st custom field.
custom102string- The value of the product's 102nd custom field.
custom103string- The value of the product's 103rd custom field.
custom104string- The value of the product's 104th custom field.
custom105string- The value of the product's 105th custom field.
custom106string- The value of the product's 106th custom field.
custom107string- The value of the product's 107th custom field.
custom108string- The value of the product's 108th custom field.
custom109string- The value of the product's 109th custom field.
custom11string- The value of the product's 11th custom field.
custom110string- The value of the product's 110th custom field.
custom111string- The value of the product's 111th custom field.
custom112string- The value of the product's 112th custom field.
custom113string- The value of the product's 113th custom field.
custom114string- The value of the product's 114th custom field.
custom115string- The value of the product's 115th custom field.
custom116string- The value of the product's 116th custom field.
custom117string- The value of the product's 117th custom field.
custom118string- The value of the product's 118th custom field.
custom119string- The value of the product's 119th custom field.
custom12string- The value of the product's 12th custom field.
custom120string- The value of the product's 120th custom field.
custom121string- The value of the product's 121st custom field.
custom122string- The value of the product's 122nd custom field.
custom123string- The value of the product's 123rd custom field.
custom124string- The value of the product's 124th custom field.
custom125string- The value of the product's 125th custom field.
custom126string- The value of the product's 126th custom field.
custom127string- The value of the product's 127th custom field.
custom128string- The value of the product's 128th custom field.
custom129string- The value of the product's 129th custom field.
custom13string- The value of the product's 13th custom field.
custom130string- The value of the product's 130th custom field.
custom131string- The value of the product's 131st custom field.
custom132string- The value of the product's 132nd custom field.
custom133string- The value of the product's 133rd custom field.
custom134string- The value of the product's 134th custom field.
custom135string- The value of the product's 135th custom field.
custom136string- The value of the product's 136th custom field.
custom137string- The value of the product's 137th custom field.
custom138string- The value of the product's 138th custom field.
custom139string- The value of the product's 139th custom field.
custom14string- The value of the product's 14th custom field.
custom140string- The value of the product's 140th custom field.
custom141string- The value of the product's 141st custom field.
custom142string- The value of the product's 142nd custom field.
custom143string- The value of the product's 143rd custom field.
custom144string- The value of the product's 144th custom field.
custom145string- The value of the product's 145th custom field.
custom146string- The value of the product's 146th custom field.
custom147string- The value of the product's 147th custom field.
custom148string- The value of the product's 148th custom field.
custom149string- The value of the product's 149th custom field.
custom15string- The value of the product's 15th custom field.
custom150string- The value of the product's 150th custom field.
custom16string- The value of the product's 16th custom field.
custom17string- The value of the product's 17th custom field.
custom18string- The value of the product's 18th custom field.
custom19string- The value of the product's 19th custom field.
custom2string- The value of the product's second custom field.
custom20string- The value of the product's 20th custom field.
custom21string- The value of the product's 21st custom field.
custom22string- The value of the product's 22nd custom field.
custom23string- The value of the product's 23rd custom field.
custom24string- The value of the product's 24th custom field.
custom25string- The value of the product's 25th custom field.
custom26string- The value of the product's 26th custom field.
custom27string- The value of the product's 27th custom field.
custom28string- The value of the product's 28th custom field.
custom29string- The value of the product's 29th custom field.
custom3string- The value of the product's third custom field.
custom30string- The value of the product's 30th custom field.
custom31string- The value of the product's 31st custom field.
custom32string- The value of the product's 32nd custom field.
custom33string- The value of the product's 33rd custom field.
custom34string- The value of the product's 34th custom field.
custom35string- The value of the product's 35th custom field.
custom36string- The value of the product's 36th custom field.
custom37string- The value of the product's 37th custom field.
custom38string- The value of the product's 38th custom field.
custom39string- The value of the product's 39th custom field.
custom4string- The value of the product's fourth custom field.
custom40string- The value of the product's 40th custom field.
custom41string- The value of the product's 41st custom field.
custom42string- The value of the product's 42nd custom field.
custom43string- The value of the product's 43rd custom field.
custom44string- The value of the product's 44th custom field.
custom45string- The value of the product's 45th custom field.
custom46string- The value of the product's 46th custom field.
custom47string- The value of the product's 47th custom field.
custom48string- The value of the product's 48th custom field.
custom49string- The value of the product's 49th custom field.
custom5string- The value of the product's fifth custom field.
custom50string- The value of the product's 50th custom field.
custom51string- The value of the product's 51st custom field.
custom52string- The value of the product's 52nd custom field.
custom53string- The value of the product's 53rd custom field.
custom54string- The value of the product's 54th custom field.
custom55string- The value of the product's 55th custom field.
custom56string- The value of the product's 56th custom field.
custom57string- The value of the product's 57th custom field.
custom58string- The value of the product's 58th custom field.
custom59string- The value of the product's 59th custom field.
custom6string- The value of the product's sixth custom field.
custom60string- The value of the product's 60th custom field.
custom61string- The value of the product's 61st custom field.
custom62string- The value of the product's 62nd custom field.
custom63string- The value of the product's 63rd custom field.
custom64string- The value of the product's 64th custom field.
custom65string- The value of the product's 65th custom field.
custom66string- The value of the product's 66th custom field.
custom67string- The value of the product's 67th custom field.
custom68string- The value of the product's 68th custom field.
custom69string- The value of the product's 69th custom field.
custom7string- The value of the product's seventh custom field.
custom70string- The value of the product's 70th custom field.
custom71string- The value of the product's 71st custom field.
custom72string- The value of the product's 72nd custom field.
custom73string- The value of the product's 73rd custom field.
custom74string- The value of the product's 74th custom field.
custom75string- The value of the product's 75th custom field.
custom76string- The value of the product's 76th custom field.
custom77string- The value of the product's 77th custom field.
custom78string- The value of the product's 78th custom field.
custom79string- The value of the product's 79th custom field.
custom8string- The value of the product's eight custom field.
custom80string- The value of the product's 80th custom field.
custom81string- The value of the product's 81st custom field.
custom82string- The value of the product's 82nd custom field.
custom83string- The value of the product's 83rd custom field.
custom84string- The value of the product's 84th custom field.
custom85string- The value of the product's 85th custom field.
custom86string- The value of the product's 86th custom field.
custom87string- The value of the product's 87th custom field.
custom88string- The value of the product's 88th custom field.
custom89string- The value of the product's 89th custom field.
custom9string- The value of the product's ninth custom field.
custom90string- The value of the product's 90th custom field.
custom91string- The value of the product's 91st custom field.
custom92string- The value of the product's 92nd custom field.
custom93string- The value of the product's 93rd custom field.
custom94string- The value of the product's 94th custom field.
custom95string- The value of the product's 95th custom field.
custom96string- The value of the product's 96th custom field.
custom97string- The value of the product's 97th custom field.
custom98string- The value of the product's 98th custom field.
custom99string- The value of the product's 99th custom field.
deletedboolean- A boolean value whether the product has deleted or not.
descriptionstring- A custom description of the product. (maximum 16777215 characters.)
namestring- Name of a product. (maximum 255 characters.)
owner_idinteger- The owner of this task. Provide the numeric Outreach ID.
product_familystring- Name of Product Family associated with the Product. (maximum 255 characters.)
statusboolean- A boolean value whether the product is active or not.
unit_of_measurestring- Unit of the product; for example, kilograms, liters, or cases. (maximum 255 characters.)
websitestring- Website URL of this product. (maximum 255 characters.)
outreach_profiles_createCreate a new profile in Outreach.WriteCreate Profile
Create a new profile in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_profiles_update to change one later and use outreach_profiles_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
namestring- The name of the profile (e.g. "Admin"). (maximum 255 characters.)
outreach_profiles_updateUpdate an existing profile in Outreach.WriteUpdate Profile
Update an existing profile in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_profiles_create to make a new one, and use outreach_profiles_get to read the current values. Requires the profile id.
- Idempotent
Inputs
profile_idintegerrequired- Numeric Outreach ID of the profile. Find it with outreach_profiles_list.
namestring- The name of the profile (e.g. "Admin"). (maximum 255 characters.)
outreach_prospect_note_createAdd a note to a prospect in Outreach, e.g.WriteCreate Prospect Note
Add a note to a prospect in Outreach, e.g. to log a meeting, call, or general observation.
Inputs
messagestringrequired- Text content of the note
prospect_idintegerrequired- ID of the prospect to attach this note to
note_typestring- Context of the note. One of 'note', 'call', 'coffee', 'beer', 'meeting'
opportunity_idinteger- ID of an opportunity to associate this note with
pinnedboolean- Whether to pin this note to the top of the prospect's note list
outreach_prospect_notes_updateUpdate an existing prospect note in Outreach.WriteUpdate Prospect Note
Update an existing prospect note in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_prospect_notes_get to read the current values. Requires the prospect note id.
- Idempotent
Inputs
prospect_note_idintegerrequired- Numeric Outreach ID of the prospect note. Find it with outreach_prospect_notes_list.
messagestring- The text content of this prospect note. (maximum 65535 characters.)
note_typestring- The context of this prospect note, one of {note,call,coffee,beer,meeting}. (maximum 255 characters.)
opportunity_association_rulestring- The rule used to associate the account note with an opportunity, one of {recent_created,recent_updated}. (maximum 255 characters.)
pinnedboolean- A boolean value indicating whether this prospect note is pinned.
prospect_idinteger- The prospect this prospect note is related to. Provide the numeric Outreach ID.
outreach_prospects_createCreate a new prospect in Outreach.WriteCreate Prospect
Create a new prospect in Outreach. Provide at minimum a first name, last name, or email address.
Inputs
account_idinteger- ID of the account to associate with this prospect
address_citystring- City of the prospect's address
address_countrystring- Country of the prospect's address
address_statestring- State of the prospect's address
companystring- Company name of the prospect
emailsarray- Array of email addresses for the prospect
first_namestring- First name of the prospect
github_urlstring- GitHub profile URL of the prospect
last_namestring- Last name of the prospect
linkedin_urlstring- LinkedIn profile URL of the prospect
owner_idinteger- ID of the user (owner) to assign this prospect to
phonesarray- Array of phone numbers for the prospect
tagsarray- Array of tags to apply to the prospect
titlestring- Job title of the prospect
website_urlstring- Personal or company website URL of the prospect
outreach_prospects_updateUpdate an existing prospect in Outreach.WriteUpdate Prospect
Update an existing prospect in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
prospect_idintegerrequired- The unique identifier of the prospect to update
account_idinteger- ID of the account to associate with this prospect
address_citystring- City of the prospect's address
address_countrystring- Country of the prospect's address
address_statestring- State of the prospect's address
companystring- Company name of the prospect
emailsarray- Array of email addresses for the prospect
first_namestring- First name of the prospect
last_namestring- Last name of the prospect
linkedin_urlstring- LinkedIn profile URL of the prospect
owner_idinteger- ID of the user (owner) to assign this prospect to
phonesarray- Array of phone numbers for the prospect
tagsarray- Array of tags to apply to the prospect
titlestring- Job title of the prospect
outreach_purchases_createCreate a new purchase in Outreach.WriteCreate Purchase
Create a new purchase in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_purchases_update to change one later and use outreach_purchases_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
account_idinteger- The associated account. Provide the numeric Outreach ID.
currencystring- It tells you what type of currency we are using to purchase. (maximum 255 characters.)
custom1string- The value of the purchases first custom field.
custom10string- The value of the purchases 10th custom field.
custom100string- The value of the purchases 100th custom field.
custom101string- The value of the purchases 101st custom field.
custom102string- The value of the purchases 102nd custom field.
custom103string- The value of the purchases 103rd custom field.
custom104string- The value of the purchases 104th custom field.
custom105string- The value of the purchases 105th custom field.
custom106string- The value of the purchases 106th custom field.
custom107string- The value of the purchases 107th custom field.
custom108string- The value of the purchases 108th custom field.
custom109string- The value of the purchases 109th custom field.
custom11string- The value of the purchases 11th custom field.
custom110string- The value of the purchases 110th custom field.
custom111string- The value of the purchases 111th custom field.
custom112string- The value of the purchases 112th custom field.
custom113string- The value of the purchases 113th custom field.
custom114string- The value of the purchases 114th custom field.
custom115string- The value of the purchases 115th custom field.
custom116string- The value of the purchases 116th custom field.
custom117string- The value of the purchases 117th custom field.
custom118string- The value of the purchases 118th custom field.
custom119string- The value of the purchases 119th custom field.
custom12string- The value of the purchases 12th custom field.
custom120string- The value of the purchases 120th custom field.
custom121string- The value of the purchases 121st custom field.
custom122string- The value of the purchases 122nd custom field.
custom123string- The value of the purchases 123rd custom field.
custom124string- The value of the purchases 124th custom field.
custom125string- The value of the purchases 125th custom field.
custom126string- The value of the purchases 126th custom field.
custom127string- The value of the purchases 127th custom field.
custom128string- The value of the purchases 128th custom field.
custom129string- The value of the purchases 129th custom field.
custom13string- The value of the purchases 13th custom field.
custom130string- The value of the purchases 130th custom field.
custom131string- The value of the purchases 131st custom field.
custom132string- The value of the purchases 132nd custom field.
custom133string- The value of the purchases 133rd custom field.
custom134string- The value of the purchases 134th custom field.
custom135string- The value of the purchases 135th custom field.
custom136string- The value of the purchases 136th custom field.
custom137string- The value of the purchases 137th custom field.
custom138string- The value of the purchases 138th custom field.
custom139string- The value of the purchases 139th custom field.
custom14string- The value of the purchases 14th custom field.
custom140string- The value of the purchases 140th custom field.
custom141string- The value of the purchases 141st custom field.
custom142string- The value of the purchases 142nd custom field.
custom143string- The value of the purchases 143rd custom field.
custom144string- The value of the purchases 144th custom field.
custom145string- The value of the purchases 145th custom field.
custom146string- The value of the purchases 146th custom field.
custom147string- The value of the purchases 147th custom field.
custom148string- The value of the purchases 148th custom field.
custom149string- The value of the purchases 149th custom field.
custom15string- The value of the purchases 15th custom field.
custom150string- The value of the purchases 150th custom field.
custom16string- The value of the purchases 16th custom field.
custom17string- The value of the purchases 17th custom field.
custom18string- The value of the purchases 18th custom field.
custom19string- The value of the purchases 19th custom field.
custom2string- The value of the purchases second custom field.
custom20string- The value of the purchases 20th custom field.
custom21string- The value of the purchases 21st custom field.
custom22string- The value of the purchases 22nd custom field.
custom23string- The value of the purchases 23rd custom field.
custom24string- The value of the purchases 24th custom field.
custom25string- The value of the purchases 25th custom field.
custom26string- The value of the purchases 26th custom field.
custom27string- The value of the purchases 27th custom field.
custom28string- The value of the purchases 28th custom field.
custom29string- The value of the purchases 29th custom field.
custom3string- The value of the purchases third custom field.
custom30string- The value of the purchases 30th custom field.
custom31string- The value of the purchases 31st custom field.
custom32string- The value of the purchases 32nd custom field.
custom33string- The value of the purchases 33rd custom field.
custom34string- The value of the purchases 34th custom field.
custom35string- The value of the purchases 35th custom field.
custom36string- The value of the purchases 36th custom field.
custom37string- The value of the purchases 37th custom field.
custom38string- The value of the purchases 38th custom field.
custom39string- The value of the purchases 39th custom field.
custom4string- The value of the purchases fourth custom field.
custom40string- The value of the purchases 40th custom field.
custom41string- The value of the purchases 41st custom field.
custom42string- The value of the purchases 42nd custom field.
custom43string- The value of the purchases 43rd custom field.
custom44string- The value of the purchases 44th custom field.
custom45string- The value of the purchases 45th custom field.
custom46string- The value of the purchases 46th custom field.
custom47string- The value of the purchases 47th custom field.
custom48string- The value of the purchases 48th custom field.
custom49string- The value of the purchases 49th custom field.
custom5string- The value of the purchases fifth custom field.
custom50string- The value of the purchases 50th custom field.
custom51string- The value of the purchases 51st custom field.
custom52string- The value of the purchases 52nd custom field.
custom53string- The value of the purchases 53rd custom field.
custom54string- The value of the purchases 54th custom field.
custom55string- The value of the purchases 55th custom field.
custom56string- The value of the purchases 56th custom field.
custom57string- The value of the purchases 57th custom field.
custom58string- The value of the purchases 58th custom field.
custom59string- The value of the purchases 59th custom field.
custom6string- The value of the purchases sixth custom field.
custom60string- The value of the purchases 60th custom field.
custom61string- The value of the purchases 61st custom field.
custom62string- The value of the purchases 62nd custom field.
custom63string- The value of the purchases 63rd custom field.
custom64string- The value of the purchases 64th custom field.
custom65string- The value of the purchases 65th custom field.
custom66string- The value of the purchases 66th custom field.
custom67string- The value of the purchases 67th custom field.
custom68string- The value of the purchases 68th custom field.
custom69string- The value of the purchases 69th custom field.
custom7string- The value of the purchases seventh custom field.
custom70string- The value of the purchases 70th custom field.
custom71string- The value of the purchases 71st custom field.
custom72string- The value of the purchases 72nd custom field.
custom73string- The value of the purchases 73rd custom field.
custom74string- The value of the purchases 74th custom field.
custom75string- The value of the purchases 75th custom field.
custom76string- The value of the purchases 76th custom field.
custom77string- The value of the purchases 77th custom field.
custom78string- The value of the purchases 78th custom field.
custom79string- The value of the purchases 79th custom field.
custom8string- The value of the purchases eight custom field.
custom80string- The value of the purchases 80th custom field.
custom81string- The value of the purchases 81st custom field.
custom82string- The value of the purchases 82nd custom field.
custom83string- The value of the purchases 83rd custom field.
custom84string- The value of the purchases 84th custom field.
custom85string- The value of the purchases 85th custom field.
custom86string- The value of the purchases 86th custom field.
custom87string- The value of the purchases 87th custom field.
custom88string- The value of the purchases 88th custom field.
custom89string- The value of the purchases 89th custom field.
custom9string- The value of the purchases ninth custom field.
custom90string- The value of the purchases 90th custom field.
custom91string- The value of the purchases 91st custom field.
custom92string- The value of the purchases 92nd custom field.
custom93string- The value of the purchases 93rd custom field.
custom94string- The value of the purchases 94th custom field.
custom95string- The value of the purchases 95th custom field.
custom96string- The value of the purchases 96th custom field.
custom97string- The value of the purchases 97th custom field.
custom98string- The value of the purchases 98th custom field.
custom99string- The value of the purchases 99th custom field.
descriptionstring- A description of the purchase. (maximum 65535 characters.)
end_datestring- End Date of Contract.
owner_idinteger- The owner of the purchase. Provide the numeric Outreach ID.
potential_quantitynumber- Net Potential within an Account.
potential_valuenumber- Net Potential Revenue within an Account.
product_idinteger- The associated product. Provide the numeric Outreach ID.
saturationnumber- Contract seat as a % of potential.
sourcestring- It tells how the purchase record was populated. Either is it manual or some API or some other source. (maximum 255 characters.)
start_datestring- Start Date of Contract.
statusboolean- A boolean value whether the product is active or not.
total_quantitynumber- Net Contracted Quantity (Always less than or equal to the potential).
total_valuenumber- Net Current Revenue Sold.
outreach_purchases_updateUpdate an existing purchase in Outreach.WriteUpdate Purchase
Update an existing purchase in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_purchases_create to make a new one, and use outreach_purchases_get to read the current values. Requires the purchase id.
- Idempotent
Inputs
purchase_idintegerrequired- Numeric Outreach ID of the purchase. Find it with outreach_purchases_list.
account_idinteger- The associated account. Provide the numeric Outreach ID.
currencystring- It tells you what type of currency we are using to purchase. (maximum 255 characters.)
custom1string- The value of the purchases first custom field.
custom10string- The value of the purchases 10th custom field.
custom100string- The value of the purchases 100th custom field.
custom101string- The value of the purchases 101st custom field.
custom102string- The value of the purchases 102nd custom field.
custom103string- The value of the purchases 103rd custom field.
custom104string- The value of the purchases 104th custom field.
custom105string- The value of the purchases 105th custom field.
custom106string- The value of the purchases 106th custom field.
custom107string- The value of the purchases 107th custom field.
custom108string- The value of the purchases 108th custom field.
custom109string- The value of the purchases 109th custom field.
custom11string- The value of the purchases 11th custom field.
custom110string- The value of the purchases 110th custom field.
custom111string- The value of the purchases 111th custom field.
custom112string- The value of the purchases 112th custom field.
custom113string- The value of the purchases 113th custom field.
custom114string- The value of the purchases 114th custom field.
custom115string- The value of the purchases 115th custom field.
custom116string- The value of the purchases 116th custom field.
custom117string- The value of the purchases 117th custom field.
custom118string- The value of the purchases 118th custom field.
custom119string- The value of the purchases 119th custom field.
custom12string- The value of the purchases 12th custom field.
custom120string- The value of the purchases 120th custom field.
custom121string- The value of the purchases 121st custom field.
custom122string- The value of the purchases 122nd custom field.
custom123string- The value of the purchases 123rd custom field.
custom124string- The value of the purchases 124th custom field.
custom125string- The value of the purchases 125th custom field.
custom126string- The value of the purchases 126th custom field.
custom127string- The value of the purchases 127th custom field.
custom128string- The value of the purchases 128th custom field.
custom129string- The value of the purchases 129th custom field.
custom13string- The value of the purchases 13th custom field.
custom130string- The value of the purchases 130th custom field.
custom131string- The value of the purchases 131st custom field.
custom132string- The value of the purchases 132nd custom field.
custom133string- The value of the purchases 133rd custom field.
custom134string- The value of the purchases 134th custom field.
custom135string- The value of the purchases 135th custom field.
custom136string- The value of the purchases 136th custom field.
custom137string- The value of the purchases 137th custom field.
custom138string- The value of the purchases 138th custom field.
custom139string- The value of the purchases 139th custom field.
custom14string- The value of the purchases 14th custom field.
custom140string- The value of the purchases 140th custom field.
custom141string- The value of the purchases 141st custom field.
custom142string- The value of the purchases 142nd custom field.
custom143string- The value of the purchases 143rd custom field.
custom144string- The value of the purchases 144th custom field.
custom145string- The value of the purchases 145th custom field.
custom146string- The value of the purchases 146th custom field.
custom147string- The value of the purchases 147th custom field.
custom148string- The value of the purchases 148th custom field.
custom149string- The value of the purchases 149th custom field.
custom15string- The value of the purchases 15th custom field.
custom150string- The value of the purchases 150th custom field.
custom16string- The value of the purchases 16th custom field.
custom17string- The value of the purchases 17th custom field.
custom18string- The value of the purchases 18th custom field.
custom19string- The value of the purchases 19th custom field.
custom2string- The value of the purchases second custom field.
custom20string- The value of the purchases 20th custom field.
custom21string- The value of the purchases 21st custom field.
custom22string- The value of the purchases 22nd custom field.
custom23string- The value of the purchases 23rd custom field.
custom24string- The value of the purchases 24th custom field.
custom25string- The value of the purchases 25th custom field.
custom26string- The value of the purchases 26th custom field.
custom27string- The value of the purchases 27th custom field.
custom28string- The value of the purchases 28th custom field.
custom29string- The value of the purchases 29th custom field.
custom3string- The value of the purchases third custom field.
custom30string- The value of the purchases 30th custom field.
custom31string- The value of the purchases 31st custom field.
custom32string- The value of the purchases 32nd custom field.
custom33string- The value of the purchases 33rd custom field.
custom34string- The value of the purchases 34th custom field.
custom35string- The value of the purchases 35th custom field.
custom36string- The value of the purchases 36th custom field.
custom37string- The value of the purchases 37th custom field.
custom38string- The value of the purchases 38th custom field.
custom39string- The value of the purchases 39th custom field.
custom4string- The value of the purchases fourth custom field.
custom40string- The value of the purchases 40th custom field.
custom41string- The value of the purchases 41st custom field.
custom42string- The value of the purchases 42nd custom field.
custom43string- The value of the purchases 43rd custom field.
custom44string- The value of the purchases 44th custom field.
custom45string- The value of the purchases 45th custom field.
custom46string- The value of the purchases 46th custom field.
custom47string- The value of the purchases 47th custom field.
custom48string- The value of the purchases 48th custom field.
custom49string- The value of the purchases 49th custom field.
custom5string- The value of the purchases fifth custom field.
custom50string- The value of the purchases 50th custom field.
custom51string- The value of the purchases 51st custom field.
custom52string- The value of the purchases 52nd custom field.
custom53string- The value of the purchases 53rd custom field.
custom54string- The value of the purchases 54th custom field.
custom55string- The value of the purchases 55th custom field.
custom56string- The value of the purchases 56th custom field.
custom57string- The value of the purchases 57th custom field.
custom58string- The value of the purchases 58th custom field.
custom59string- The value of the purchases 59th custom field.
custom6string- The value of the purchases sixth custom field.
custom60string- The value of the purchases 60th custom field.
custom61string- The value of the purchases 61st custom field.
custom62string- The value of the purchases 62nd custom field.
custom63string- The value of the purchases 63rd custom field.
custom64string- The value of the purchases 64th custom field.
custom65string- The value of the purchases 65th custom field.
custom66string- The value of the purchases 66th custom field.
custom67string- The value of the purchases 67th custom field.
custom68string- The value of the purchases 68th custom field.
custom69string- The value of the purchases 69th custom field.
custom7string- The value of the purchases seventh custom field.
custom70string- The value of the purchases 70th custom field.
custom71string- The value of the purchases 71st custom field.
custom72string- The value of the purchases 72nd custom field.
custom73string- The value of the purchases 73rd custom field.
custom74string- The value of the purchases 74th custom field.
custom75string- The value of the purchases 75th custom field.
custom76string- The value of the purchases 76th custom field.
custom77string- The value of the purchases 77th custom field.
custom78string- The value of the purchases 78th custom field.
custom79string- The value of the purchases 79th custom field.
custom8string- The value of the purchases eight custom field.
custom80string- The value of the purchases 80th custom field.
custom81string- The value of the purchases 81st custom field.
custom82string- The value of the purchases 82nd custom field.
custom83string- The value of the purchases 83rd custom field.
custom84string- The value of the purchases 84th custom field.
custom85string- The value of the purchases 85th custom field.
custom86string- The value of the purchases 86th custom field.
custom87string- The value of the purchases 87th custom field.
custom88string- The value of the purchases 88th custom field.
custom89string- The value of the purchases 89th custom field.
custom9string- The value of the purchases ninth custom field.
custom90string- The value of the purchases 90th custom field.
custom91string- The value of the purchases 91st custom field.
custom92string- The value of the purchases 92nd custom field.
custom93string- The value of the purchases 93rd custom field.
custom94string- The value of the purchases 94th custom field.
custom95string- The value of the purchases 95th custom field.
custom96string- The value of the purchases 96th custom field.
custom97string- The value of the purchases 97th custom field.
custom98string- The value of the purchases 98th custom field.
custom99string- The value of the purchases 99th custom field.
descriptionstring- A description of the purchase. (maximum 65535 characters.)
end_datestring- End Date of Contract.
owner_idinteger- The owner of the purchase. Provide the numeric Outreach ID.
potential_quantitynumber- Net Potential within an Account.
potential_valuenumber- Net Potential Revenue within an Account.
product_idinteger- The associated product. Provide the numeric Outreach ID.
saturationnumber- Contract seat as a % of potential.
sourcestring- It tells how the purchase record was populated. Either is it manual or some API or some other source. (maximum 255 characters.)
start_datestring- Start Date of Contract.
statusboolean- A boolean value whether the product is active or not.
total_quantitynumber- Net Contracted Quantity (Always less than or equal to the potential).
total_valuenumber- Net Current Revenue Sold.
outreach_recipients_createCreate a new recipient in Outreach.WriteCreate Recipient
Create a new recipient in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_recipients_update to change one later and use outreach_recipients_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
email_hashstring- Hash of email for recipient. (maximum 255 characters.)
primaryboolean- True when the recipient is the primary recipient.
prospect_idinteger- The prospect entity relation. Provide the numeric Outreach ID.
recipient_typestring- The type of action for the communcation to the recipient. Must be one of 'bcc', 'cc', or 'to'. (maximum 3 characters.)
user_idinteger- The user entity relation. Provide the numeric Outreach ID.
valuestring- The recipient contact information (i.e. email address). (maximum 255 characters.)
outreach_recipients_updateUpdate an existing recipient in Outreach.WriteUpdate Recipient
Update an existing recipient in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_recipients_create to make a new one, and use outreach_recipients_get to read the current values. Requires the recipient id.
- Idempotent
Inputs
recipient_idintegerrequired- Numeric Outreach ID of the recipient. Find it with outreach_recipients_list.
email_hashstring- Hash of email for recipient. (maximum 255 characters.)
primaryboolean- True when the recipient is the primary recipient.
prospect_idinteger- The prospect entity relation. Provide the numeric Outreach ID.
recipient_typestring- The type of action for the communcation to the recipient. Must be one of 'bcc', 'cc', or 'to'. (maximum 3 characters.)
user_idinteger- The user entity relation. Provide the numeric Outreach ID.
valuestring- The recipient contact information (i.e. email address). (maximum 255 characters.)
outreach_roles_createCreate a new role in Outreach.WriteCreate Role
Create a new role in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_roles_update to change one later and use outreach_roles_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
external_idstring- The permanent, immutable identifier of the role. (maximum 255 characters.)
namestring- The name of the role (e.g. "Vice-President"). (maximum 255 characters.)
parent_role_idinteger- Roles are heirarchical. This is the parent of the current role. Provide the numeric Outreach ID.
outreach_roles_updateUpdate an existing role in Outreach.WriteUpdate Role
Update an existing role in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_roles_create to make a new one, and use outreach_roles_get to read the current values. Requires the role id.
- Idempotent
Inputs
role_idintegerrequired- Numeric Outreach ID of the role. Find it with outreach_roles_list.
namestring- The name of the role (e.g. "Vice-President"). (maximum 255 characters.)
parent_role_idinteger- Roles are heirarchical. This is the parent of the current role. Provide the numeric Outreach ID.
outreach_rulesets_createCreate a new ruleset in Outreach.WriteCreate Ruleset
Create a new ruleset in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_rulesets_update to change one later and use outreach_rulesets_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
apply_completed_stage_ininteger- The amount of time in seconds after the sequence has completed before the "completedStage" will be applied to the Prospect.
auto_resume_ooto_prospectsboolean- A boolean value whether out-of-the-office Prospects will be automatically resumed. See "autoResumeOotoProspectsIn" and "autoResumeOotoProspectsExpiresIn" for more information.
auto_resume_ooto_prospects_expires_ininteger- The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.
auto_resume_ooto_prospects_ininteger- The default amount of time in seconds to wait before opted-out Prospects will be resumed.
bounced_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence bounces. Provide the numeric Outreach ID.
call_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of calling. (maximum 4 characters.)
call_task_priority_from_clicks_idinteger- The task priority to use when creating call tasks based on mail clicks. Provide the numeric Outreach ID.
call_task_priority_from_opens_idinteger- The task priority to use when creating call tasks based on mail opens. Provide the numeric Outreach ID.
call_task_priority_idinteger- The task priority to use when creating call tasks based on mail opens. Provide the numeric Outreach ID.
clicks_needed_before_call_task_createdinteger- The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.
completed_stage_idinteger- The stage to assign to the prospect when this sequence completes. Provide the numeric Outreach ID.
delivered_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence is delivered. Provide the numeric Outreach ID.
email_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of emails. (maximum 4 characters.)
finished_stage_idinteger- The stage to assign to the prospect when this sequence finishes. Provide the numeric Outreach ID.
include_unsubscribe_linksboolean- A boolean value whether to include unsubscribe links within emails.
meeting_booked_actionstring- Determines if a prospect is marked as finished when a meeting is booked. (maximum 255 characters.)
minimum_prospect_touched_intervalinteger- The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequnce. This feature will be disabled unless a value is set.
namestring- The name of the ruleset. (maximum 255 characters.)
ooto_auto_extraction_enabledboolean- A boolean value determining whether to use out of the office return date auto extraction.
opens_needed_before_call_task_createdinteger- The number of email opens needed before a call task will be automatically created. This feature will be disabled unless a value is set.
opted_out_stage_idinteger- The stage to assign to the prospect when they opt out of this sequence. Provide the numeric Outreach ID.
owner_idinteger- The owner of the ruleset. Provide the numeric Outreach ID.
permit_duplicate_prospectsstring- A value determining whether a Prospect may be added to this Sequence multiple times or not. Permitted values include "allow", "disallow" (the default) and "only_if_inactive", which indicates that Prospects may be re-added to this sequence if their existing SequenceState is inactive. (maximum 255 characters.)
replied_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence is replied to. Provide the numeric Outreach ID.
sequence_exclusivitystring- A value determining whether Prospects may be added to multiple different Sequences. Permitted values include "all_sequences", "exclusive_sequences" and "none" (the default). If the value is "all_sequences", then Prospects may only be added if they are not active in any other Sequence; likewise, a Prospect active in a Sequence with "all_sequences" exclusivity cannot be added to any other Sequence. If the value is "exclusive_sequences", then Prospects may only be added if they are not active in any other Sequence with "exclusive_sequences" exclusivity; likewise, a Prospect active in a Sequence with "exclusive_sequences" exclusivity cannot be added to any other Sequence with "exclusive_sequences" exclusivity. If the value is "none", then no additional restrictions will be applied. (maximum 255 characters.)
sms_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of SMS. (maximum 4 characters.)
sms_received_actionstring- Determines if a prospect is marked as finished when a text message is received. (maximum 255 characters.)
started_stage_idinteger- The stage to assign to the prospect when this sequence starts. Provide the numeric Outreach ID.
step_overrides_enabledboolean- A boolean value determining whether to allow users to customize step templates when adding to sequence.
outreach_rulesets_updateUpdate an existing ruleset in Outreach.WriteUpdate Ruleset
Update an existing ruleset in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_rulesets_create to make a new one, and use outreach_rulesets_get to read the current values. Requires the ruleset id.
- Idempotent
Inputs
ruleset_idintegerrequired- Numeric Outreach ID of the ruleset. Find it with outreach_rulesets_list.
apply_completed_stage_ininteger- The amount of time in seconds after the sequence has completed before the "completedStage" will be applied to the Prospect.
auto_resume_ooto_prospectsboolean- A boolean value whether out-of-the-office Prospects will be automatically resumed. See "autoResumeOotoProspectsIn" and "autoResumeOotoProspectsExpiresIn" for more information.
auto_resume_ooto_prospects_expires_ininteger- The maximum amount of time in seconds to wait before opted-out Prospect will be resumed.
auto_resume_ooto_prospects_ininteger- The default amount of time in seconds to wait before opted-out Prospects will be resumed.
bounced_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence bounces. Provide the numeric Outreach ID.
call_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of calling. (maximum 4 characters.)
call_task_priority_from_clicks_idinteger- The task priority to use when creating call tasks based on mail clicks. Provide the numeric Outreach ID.
call_task_priority_from_opens_idinteger- The task priority to use when creating call tasks based on mail opens. Provide the numeric Outreach ID.
call_task_priority_idinteger- The task priority to use when creating call tasks based on mail opens. Provide the numeric Outreach ID.
clicks_needed_before_call_task_createdinteger- The number of email clicks needed before a call task will be automatically created. This feature will be disabled unless a value is set.
completed_stage_idinteger- The stage to assign to the prospect when this sequence completes. Provide the numeric Outreach ID.
delivered_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence is delivered. Provide the numeric Outreach ID.
email_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of emails. (maximum 4 characters.)
finished_stage_idinteger- The stage to assign to the prospect when this sequence finishes. Provide the numeric Outreach ID.
include_unsubscribe_linksboolean- A boolean value whether to include unsubscribe links within emails.
meeting_booked_actionstring- Determines if a prospect is marked as finished when a meeting is booked. (maximum 255 characters.)
minimum_prospect_touched_intervalinteger- The minimum number of seconds that must elapse between when a Prospect was last contacted and when they may be added to a sequnce. This feature will be disabled unless a value is set.
namestring- The name of the ruleset. (maximum 255 characters.)
ooto_auto_extraction_enabledboolean- A boolean value determining whether to use out of the office return date auto extraction.
opens_needed_before_call_task_createdinteger- The number of email opens needed before a call task will be automatically created. This feature will be disabled unless a value is set.
opted_out_stage_idinteger- The stage to assign to the prospect when they opt out of this sequence. Provide the numeric Outreach ID.
owner_idinteger- The owner of the ruleset. Provide the numeric Outreach ID.
permit_duplicate_prospectsstring- A value determining whether a Prospect may be added to this Sequence multiple times or not. Permitted values include "allow", "disallow" (the default) and "only_if_inactive", which indicates that Prospects may be re-added to this sequence if their existing SequenceState is inactive. (maximum 255 characters.)
replied_stage_idinteger- The stage to assign to the prospect when a mailing in this sequence is replied to. Provide the numeric Outreach ID.
sequence_exclusivitystring- A value determining whether Prospects may be added to multiple different Sequences. Permitted values include "all_sequences", "exclusive_sequences" and "none" (the default). If the value is "all_sequences", then Prospects may only be added if they are not active in any other Sequence; likewise, a Prospect active in a Sequence with "all_sequences" exclusivity cannot be added to any other Sequence. If the value is "exclusive_sequences", then Prospects may only be added if they are not active in any other Sequence with "exclusive_sequences" exclusivity; likewise, a Prospect active in a Sequence with "exclusive_sequences" exclusivity cannot be added to any other Sequence with "exclusive_sequences" exclusivity. If the value is "none", then no additional restrictions will be applied. (maximum 255 characters.)
sms_opt_out_actionstring- Determines if prospect can be added to sequences if they are opted out of SMS. (maximum 4 characters.)
sms_received_actionstring- Determines if a prospect is marked as finished when a text message is received. (maximum 255 characters.)
started_stage_idinteger- The stage to assign to the prospect when this sequence starts. Provide the numeric Outreach ID.
step_overrides_enabledboolean- A boolean value determining whether to allow users to customize step templates when adding to sequence.
outreach_sequence_activateActivate a sequence in Outreach so enrolled prospects begin receiving its steps.WriteActivate Sequence
Activate a sequence in Outreach so enrolled prospects begin receiving its steps.
- Idempotent
Inputs
sequence_idintegerrequired- The unique identifier of the sequence to activate
outreach_sequence_deactivateDeactivate a live sequence in Outreach, stopping it from sending any further steps to enrolled prospects.WriteDeactivate Sequence
Deactivate a live sequence in Outreach, stopping it from sending any further steps to enrolled prospects.
- Idempotent
Inputs
sequence_idintegerrequired- The unique identifier of the sequence to deactivate
outreach_sequence_state_pausePause a prospect's enrollment in a sequence without deleting the enrollment record, stopping further steps until resumed.WritePause Prospect's Sequence Enrollment
Pause a prospect's enrollment in a sequence without deleting the enrollment record, stopping further steps until resumed.
- Idempotent
Inputs
sequence_state_idintegerrequired- The unique identifier of the sequence state (enrollment record) to pause
outreach_sequence_state_resumeResume a previously paused prospect sequence enrollment in Outreach so remaining steps resume sending.WriteResume Prospect's Sequence Enrollment
Resume a previously paused prospect sequence enrollment in Outreach so remaining steps resume sending.
- Idempotent
Inputs
sequence_state_idintegerrequired- The unique identifier of the sequence state (enrollment record) to resume
outreach_sequence_states_createEnroll a prospect in a sequence by creating a sequence state.WriteAdd Prospect to Sequence
Enroll a prospect in a sequence by creating a sequence state. Requires a prospect ID, sequence ID, and mailbox ID.
Inputs
mailbox_idintegerrequired- ID of the mailbox to use for sending sequence emails
prospect_idintegerrequired- ID of the prospect to enroll in the sequence
sequence_idintegerrequired- ID of the sequence to enroll the prospect in
outreach_sequence_step_createCreate a new step within an Outreach sequence.WriteCreate Sequence Step
Create a new step within an Outreach sequence. Provide 'interval' (seconds) for interval-based sequences or 'date' for date-based sequences, matching the target sequence's type.
Inputs
sequence_idintegerrequired- ID of the sequence this step belongs to
step_typestringrequired- Type of the step. Must be 'auto_email', 'manual_email', 'call', or 'task'
call_purpose_idinteger- ID of the default call purpose for this step
datestring- Calendar date this step activates. Only for date-based sequences. Format YYYY-MM-DD
intervalinteger- Seconds until this step activates. Only for interval-based sequences
orderinteger- Display order of this step within the sequence
task_autoskip_delayinteger- Seconds after which an overdue task created by this step is automatically skipped
task_notestring- Note to associate with tasks created by this step
task_priority_idinteger- ID of the task priority for this step
outreach_sequence_step_updateUpdate an existing step within an Outreach sequence.WriteUpdate Sequence Step
Update an existing step within an Outreach sequence. Only provided fields will be changed.
- Idempotent
Inputs
sequence_step_idintegerrequired- The unique identifier of the sequence step to update
datestring- Updated calendar date this step activates. Format YYYY-MM-DD
intervalinteger- Updated seconds until this step activates. Only for interval-based sequences
orderinteger- Updated display order of this step within the sequence
task_autoskip_delayinteger- Updated seconds after which an overdue task from this step is auto-skipped
task_notestring- Updated note to associate with tasks created by this step
outreach_sequence_template_activateActivate an Outreach sequence template, which enables the sequence step it is associated with.WriteActivate Sequence Template
Activate an Outreach sequence template, which enables the sequence step it is associated with. Returns the sequence template with its updated state. Use this to turn a template on; use outreach_sequence_template_deactivate to turn it off. Requires the sequence template id from outreach_sequence_templates_list.
Inputs
sequence_template_idintegerrequired- Numeric Outreach ID of the sequence template. Find it with outreach_sequence_templates_list.
outreach_sequence_template_deactivateDeactivate an Outreach sequence template, which disables the sequence step it is associated with.WriteDeactivate Sequence Template
Deactivate an Outreach sequence template, which disables the sequence step it is associated with. Returns the sequence template with its updated state. Use this to turn a template off; use outreach_sequence_template_activate to turn it back on. Requires the sequence template id from outreach_sequence_templates_list.
Inputs
sequence_template_idintegerrequired- Numeric Outreach ID of the sequence template. Find it with outreach_sequence_templates_list.
outreach_sequence_templates_createCreate a new sequence template in Outreach.WriteCreate Sequence Template
Create a new sequence template in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_sequence_templates_update to change one later and use outreach_sequence_templates_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
is_replyboolean- Boolean indicating if the sequence template should be a reply email or a new thread.
sequence_step_idinteger- The sequence step that uses the sequence template. You can use any filterable attribute of sequenceStep. Provide the numeric Outreach ID.
template_idinteger- The template used for this sequence template. Provide the numeric Outreach ID.
outreach_sequence_templates_updateUpdate an existing sequence template in Outreach.WriteUpdate Sequence Template
Update an existing sequence template in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_sequence_templates_create to make a new one, and use outreach_sequence_templates_get to read the current values. Requires the sequence template id.
- Idempotent
Inputs
sequence_template_idintegerrequired- Numeric Outreach ID of the sequence template. Find it with outreach_sequence_templates_list.
is_replyboolean- Boolean indicating if the sequence template should be a reply email or a new thread.
sequence_step_idinteger- The sequence step that uses the sequence template. You can use any filterable attribute of sequenceStep. Provide the numeric Outreach ID.
template_idinteger- The template used for this sequence template. Provide the numeric Outreach ID.
outreach_sequences_createCreate a new sequence in Outreach for automated sales engagement.WriteCreate Sequence
Create a new sequence in Outreach for automated sales engagement.
Inputs
namestringrequired- Name of the sequence
descriptionstring- Description of the sequence
owner_idinteger- ID of the user (owner) to assign this sequence to
sequence_typestring- Type of the sequence. Options: 'date' or 'interval'
tagsarray- Array of tags to apply to the sequence
outreach_sequences_updateUpdate an existing sequence in Outreach.WriteUpdate Sequence
Update an existing sequence in Outreach. Use this to rename a sequence, change its description, or enable/disable it.
- Idempotent
Inputs
sequence_idintegerrequired- The unique identifier of the sequence to update
descriptionstring- Updated description of the sequence
enabledboolean- Whether the sequence should be active/enabled
namestring- Updated name of the sequence
tagsarray- Updated array of tags for the sequence
outreach_snippet_createCreate a new reusable email snippet in Outreach.WriteCreate Snippet
Create a new reusable email snippet in Outreach. Snippets are commonly used HTML passages that can be inserted into templates and manual emails.
Inputs
namestringrequired- Name of the snippet
body_htmlstring- HTML content of the snippet
owner_idinteger- ID of the user who owns this snippet
share_typestring- Sharing permission for the snippet. Must be 'private' or 'shared'
tagsarray- Array of tags to apply to the snippet
outreach_snippet_updateUpdate an existing reusable email snippet in Outreach.WriteUpdate Snippet
Update an existing reusable email snippet in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
snippet_idintegerrequired- The unique identifier of the snippet to update
body_htmlstring- Updated HTML content of the snippet
namestring- Updated name of the snippet
share_typestring- Updated sharing permission. Must be 'private' or 'shared'
tagsarray- Updated array of tags
outreach_stages_createCreate a new stage in Outreach.WriteCreate Stage
Create a new stage in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_stages_update to change one later and use outreach_stages_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
colorstring- The color the stage label will be highlighted in the interface, specified as a hexidecimal value (e.g. "#5951ff"). (maximum 255 characters.)
namestring- The name of the stage (e.g. "Qualified Lead"). (maximum 255 characters.)
orderinteger- The stage's display order within the collection.
outreach_stages_updateUpdate an existing stage in Outreach.WriteUpdate Stage
Update an existing stage in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_stages_create to make a new one, and use outreach_stages_get to read the current values. Requires the stage id.
- Idempotent
Inputs
stage_idintegerrequired- Numeric Outreach ID of the stage. Find it with outreach_stages_list.
colorstring- The color the stage label will be highlighted in the interface, specified as a hexidecimal value (e.g. "#5951ff"). (maximum 255 characters.)
namestring- The name of the stage (e.g. "Qualified Lead"). (maximum 255 characters.)
orderinteger- The stage's display order within the collection.
outreach_task_dispositions_createCreate a new task disposition in Outreach.WriteCreate Task Disposition
Create a new task disposition in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_task_dispositions_update to change one later and use outreach_task_dispositions_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
namestring- The disposition’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The disposition’s display order within the collection.
task_typestring- The disposition’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
valuestring- The disposition’s value. (maximum 255 characters.)
outreach_task_dispositions_updateUpdate an existing task disposition in Outreach.WriteUpdate Task Disposition
Update an existing task disposition in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_task_dispositions_create to make a new one, and use outreach_task_dispositions_get to read the current values. Requires the task disposition id.
- Idempotent
Inputs
task_disposition_idintegerrequired- Numeric Outreach ID of the task disposition. Find it with outreach_task_dispositions_list.
namestring- The disposition’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The disposition’s display order within the collection.
task_typestring- The disposition’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
valuestring- The disposition’s value. (maximum 255 characters.)
outreach_task_purposes_createCreate a new task purpose in Outreach.WriteCreate Task Purpose
Create a new task purpose in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_task_purposes_update to change one later and use outreach_task_purposes_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
namestring- The purpose’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The purpose’s display order within the collection.
task_typestring- The purpose’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
outreach_task_purposes_updateUpdate an existing task purpose in Outreach.WriteUpdate Task Purpose
Update an existing task purpose in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_task_purposes_create to make a new one, and use outreach_task_purposes_get to read the current values. Requires the task purpose id.
- Idempotent
Inputs
task_purpose_idintegerrequired- Numeric Outreach ID of the task purpose. Find it with outreach_task_purposes_list.
namestring- The purpose’s name (e.g. "Initial Contact"). (maximum 255 characters.)
orderinteger- The purpose’s display order within the collection.
task_typestring- The purpose’s task type (e.g. "Meeting in Person"). (maximum 255 characters.)
outreach_task_rescheduleReschedule a task's due date in Outreach.WriteReschedule Task
Reschedule a task's due date in Outreach. Use this instead of outreach_tasks_update when the intent is specifically to move a task's due date.
- Idempotent
Inputs
due_atstringrequired- New due date/time for the task, in ISO 8601 format
task_idintegerrequired- The unique identifier of the task to reschedule
outreach_tasks_completeMark an existing task as complete in Outreach.WriteComplete Task
Mark an existing task as complete in Outreach. Only works for action_item and in_person tasks — call and email tasks cannot be completed this way. Use this instead of outreach_tasks_update to complete a task.
- Idempotent
Inputs
task_idintegerrequired- The unique identifier of the task to mark as complete
completion_notestring- Optional note to record when marking the task complete
outreach_tasks_createCreate a new task in Outreach.WriteCreate Task
Create a new task in Outreach. Tasks can represent calls, emails, in-person meetings, or general action items. Both owner_id and prospect_id are required by the Outreach API.
Inputs
actionstringrequired- Type of action for the task. Options: action_item, call, email, in_person
owner_idintegerrequired- ID of the user assigned to this task
prospect_idintegerrequired- ID of the prospect associated with this task (subject). Required — must provide either prospect_id or account_id.
due_atstring- Due date/time for the task (ISO 8601 format)
notestring- Note or description for the task
outreach_tasks_updateUpdate an existing task in Outreach.WriteUpdate Task
Update an existing task in Outreach. Supports changing action, note, and due date. To mark a task complete, use the outreach_tasks_complete tool instead.
- Idempotent
Inputs
task_idintegerrequired- The unique identifier of the task to update
actionstring- Updated action type. Options: action_item, call, email, in_person
due_atstring- Updated due date/time for the task (ISO 8601 format)
notestring- Updated note or description for the task
outreach_teams_createCreate a new team in Outreach.WriteCreate Team
Create a new team in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_teams_update to change one later and use outreach_teams_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
colorstring- The color used to label and highlight the team. (maximum 255 characters.)
content_categories_idsarray- The content categories that are assigned to the team. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
namestring- The name of the team (e.g. "SDRs"). (maximum 255 characters.)
scim_external_idstring- The ID from the SCIM provisioning service used to create the team. (maximum 255 characters.)
scim_sourcestring- The name of the SCIM provisioning source used to create the team. (maximum 255 characters.)
users_idsarray- The users associated with the team. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
outreach_teams_updateUpdate an existing team in Outreach.WriteUpdate Team
Update an existing team in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_teams_create to make a new one, and use outreach_teams_get to read the current values. Requires the team id.
- Idempotent
Inputs
team_idintegerrequired- Numeric Outreach ID of the team. Find it with outreach_teams_list.
colorstring- The color used to label and highlight the team. (maximum 255 characters.)
content_categories_idsarray- The content categories that are assigned to the team. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
namestring- The name of the team (e.g. "SDRs"). (maximum 255 characters.)
scim_external_idstring- The ID from the SCIM provisioning service used to create the team. (maximum 255 characters.)
scim_sourcestring- The name of the SCIM provisioning source used to create the team. (maximum 255 characters.)
users_idsarray- The users associated with the team. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
outreach_templates_createCreate a new email template in Outreach.WriteCreate Template
Create a new email template in Outreach. Templates can be used in sequences and for manual email sends.
Inputs
namestringrequired- Name of the template
body_htmlstring- HTML body content of the template
owner_idinteger- ID of the user who owns this template
subjectstring- Email subject line of the template
tagsarray- Array of tags to apply to the template
outreach_templates_updateUpdate an existing email template in Outreach.WriteUpdate Template
Update an existing email template in Outreach. Only provided fields will be changed.
- Idempotent
Inputs
template_idintegerrequired- The unique identifier of the template to update
body_htmlstring- Updated HTML body content
namestring- Updated name of the template
subjectstring- Updated email subject line
tagsarray- Updated array of tags
outreach_users_createCreate a new user in Outreach.WriteCreate User
Create a new user in Outreach. Returns the created record with its id, attributes, and relationship links. Use this to add a record; use outreach_users_update to change one later and use outreach_users_list to check for existing ones first. Provide the fields you want set; related records are linked by their numeric ids.
Inputs
accounts_view_idinteger- The default smart view to load on the account index view.
activity_notifications_disabledboolean- A boolean value whether the user's activity notifications are disabled.
bounce_warning_email_enabledboolean- A boolean value whether the user's bounce warning emails are enabled.
bridge_phonestring- The telephone number of the user's outbound bridge phone. (maximum 255 characters.)
bridge_phone_extensionstring- The extension number of the user's outbound bridge phone. (maximum 255 characters.)
calls_view_idinteger- The default smart view to load on the calls view.
content_categories_idsarray- The groupings of sequences, snippets and templates that this user has access to. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
controlled_tab_defaultstring- The user's preferred default tab to open when in task flow. (maximum 255 characters.)
custom1string- The value of the user's first custom field. (maximum 225 characters.)
custom2string- The value of the user's second custom field. (maximum 225 characters.)
custom3string- The value of the user's third custom field. (maximum 225 characters.)
custom4string- The value of the user's fourth custom field. (maximum 225 characters.)
custom5string- The value of the user's fifth custom field. (maximum 225 characters.)
daily_digest_email_enabledboolean- A boolean value whether the user's daily digest emails are enabled.
default_ruleset_idinteger- The id of the default ruleset assigned to the user.
dutiesobject- A collection of the user's work roles.
emailstring- The email address of the user. Cannot be updated via the API. (maximum 255 characters.)
enable_voice_recordingsboolean- A boolean value whether the user has voice recordings enabled.
engagement_emails_enabledboolean- A boolean value whether the user has engagement emails enabled.
first_namestring- The first name of the user. (maximum 255 characters.)
inbound_bridge_phonestring- The telephone number of the user's inbound bridge phone. (maximum 255 characters.)
inbound_bridge_phone_extensionstring- The extension number of the user's inbound bridge phone. (maximum 255 characters.)
inbound_call_behaviorstring- The behavior of inbound calls. Must be either "inbound_bridge" or "inbound_voicemail". (maximum 255 characters.)
inbound_phone_typestring- The user's type of telephone for inbound calls. Must be either "bridge", "voip" or "bridge_and_voip". (maximum 255 characters.)
inbound_voicemail_custom_message_textstring- The message for inbound voicemails (e.g. "Please leave a message and I will get back to you as soon I can"). (maximum 1024 characters.)
inbound_voicemail_message_text_voicestring- The gender of the voice that reads the voicemail message. Must be either "man" or "woman". (maximum 255 characters.)
inbound_voicemail_prompt_typestring- The type of inbound voicemail to use. Must be either "automated", "recorded", or "off". (maximum 255 characters.)
job_role_by_namestring- The name of the job role (e.g. "SDR"). (maximum 255 characters.)
kaia_recordings_view_idinteger- The default smart view to load on the kaia recordings view.
keep_bridge_phone_connectedboolean- Whether to keep the user's bridge phone connected in-between outbound calls.
last_namestring- The last name of the user. (maximum 255 characters.)
lockedboolean- A boolean value whether the user is locked out of the application.
mailbox_error_email_enabledboolean- A boolean value whether the user's mailbox error emails are enabled.
mailbox_idinteger- The default mailbox associated with the user. Provide the numeric Outreach ID.
mailboxes_idsarray- All mailboxes associated with the user. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
meeting_engagement_notification_enabledboolean- A boolean value whether the user's meeting engagement notifications are enabled.
notifications_enabledboolean- A boolean value whether the user's notifications are enabled.
oce_click_to_dial_everywhereboolean- A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn, and Twitter).
oce_gmail_toolbarboolean- A boolean value indicating whether the Outreach Gmail toolbar is enabled.
oce_gmail_tracking_statestring- The user's current email tracking settings when using Outreach Everywhere with GMail. (maximum 255 characters.)
oce_salesforce_email_decoratingboolean- A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.
oce_salesforce_phone_decoratingboolean- A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.
oce_universal_task_flowboolean- A boolean value indicating whether Outreach Everywhere universal task flow is enabled.
oce_window_modeboolean- A boolean value indicating whether Outreach Everywhere window mode is enabled.
opportunities_view_idinteger- The default smart view to load on the opportunity index view.
phone_country_codestring- The country code of the user's phone. (maximum 2 characters.)
phone_numberstring- The telephone number of the user's phone.
phone_typestring- The user's type of telephone for outbound calls. Must be either "bridge" or "voip". (maximum 255 characters.)
plugin_alert_notification_enabledboolean- A boolean value whether the user's plugin related error notifications are enabled.
preferred_voice_regionstring- A string that represents Twilio data center used to connect to Twilio. (maximum 255 characters.)
prefers_local_presenceboolean- A boolean value whether the user prefers that a voice call comes from a local phone number.
profile_idinteger- The user's profile in Outreach. Provide the numeric Outreach ID.
prospects_view_idinteger- The default smart view to load on the prospect index view.
recipients_idsarray- Recipients that will be included by default in all emails composed by user. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
reports_team_perf_view_idinteger- The default smart view to load on the team performance reports view.
reports_view_idinteger- The default smart view to load on the reports view.
role_idinteger- The role associated with the user. Provide the numeric Outreach ID.
scim_external_idstring- The ID from the SCIM provisioning service used to create the user. (maximum 255 characters.)
scim_sourcestring- The name of the SCIM provisioning source used to create the user. (maximum 255 characters.)
sender_notifications_excludedboolean- A boolean value whether the user's sender notifications are excluded.
tasks_view_idinteger- The default smart view to load on the tasks index view.
teams_idsarray- The teams the user belongs to. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
teams_view_idinteger- The default smart view to load on the teams index view.
texting_email_notificationsboolean- A boolean value whether to send the user email notifications when a text message is missed.
titlestring- The user's job title (e.g. "Staff Accountant"). (maximum 255 characters.)
unknown_reply_email_enabledboolean- A boolean value whether the user's unknown reply emails are enabled.
usernamestring- A reader friendly unique identifier of the user. (maximum 255 characters.)
users_view_idinteger- The default smart view to load on the users index view.
voicemail_notification_enabledboolean- A boolean value whether the user's voicemail notifications are enabled.
weekly_digest_email_enabledboolean- A boolean value whether the user's weekly digest email are enabled.
outreach_users_updateUpdate an existing user in Outreach.WriteUpdate User
Update an existing user in Outreach. Only the fields you provide are changed. Returns the updated record with its attributes and relationship links. Use this to change a record you already have; use outreach_users_create to make a new one, and use outreach_users_get to read the current values. Requires the user id.
- Idempotent
Inputs
user_idintegerrequired- Numeric Outreach ID of the user. Find it with outreach_users_list.
accounts_view_idinteger- The default smart view to load on the account index view.
activity_notifications_disabledboolean- A boolean value whether the user's activity notifications are disabled.
bounce_warning_email_enabledboolean- A boolean value whether the user's bounce warning emails are enabled.
bridge_phonestring- The telephone number of the user's outbound bridge phone. (maximum 255 characters.)
bridge_phone_extensionstring- The extension number of the user's outbound bridge phone. (maximum 255 characters.)
calls_view_idinteger- The default smart view to load on the calls view.
content_categories_idsarray- The groupings of sequences, snippets and templates that this user has access to. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
controlled_tab_defaultstring- The user's preferred default tab to open when in task flow. (maximum 255 characters.)
custom1string- The value of the user's first custom field. (maximum 225 characters.)
custom2string- The value of the user's second custom field. (maximum 225 characters.)
custom3string- The value of the user's third custom field. (maximum 225 characters.)
custom4string- The value of the user's fourth custom field. (maximum 225 characters.)
custom5string- The value of the user's fifth custom field. (maximum 225 characters.)
daily_digest_email_enabledboolean- A boolean value whether the user's daily digest emails are enabled.
default_ruleset_idinteger- The id of the default ruleset assigned to the user.
dutiesobject- A collection of the user's work roles.
enable_voice_recordingsboolean- A boolean value whether the user has voice recordings enabled.
engagement_emails_enabledboolean- A boolean value whether the user has engagement emails enabled.
first_namestring- The first name of the user. (maximum 255 characters.)
inbound_bridge_phonestring- The telephone number of the user's inbound bridge phone. (maximum 255 characters.)
inbound_bridge_phone_extensionstring- The extension number of the user's inbound bridge phone. (maximum 255 characters.)
inbound_call_behaviorstring- The behavior of inbound calls. Must be either "inbound_bridge" or "inbound_voicemail". (maximum 255 characters.)
inbound_phone_typestring- The user's type of telephone for inbound calls. Must be either "bridge", "voip" or "bridge_and_voip". (maximum 255 characters.)
inbound_voicemail_custom_message_textstring- The message for inbound voicemails (e.g. "Please leave a message and I will get back to you as soon I can"). (maximum 1024 characters.)
inbound_voicemail_message_text_voicestring- The gender of the voice that reads the voicemail message. Must be either "man" or "woman". (maximum 255 characters.)
inbound_voicemail_prompt_typestring- The type of inbound voicemail to use. Must be either "automated", "recorded", or "off". (maximum 255 characters.)
job_role_by_namestring- The name of the job role (e.g. "SDR"). (maximum 255 characters.)
kaia_recordings_view_idinteger- The default smart view to load on the kaia recordings view.
keep_bridge_phone_connectedboolean- Whether to keep the user's bridge phone connected in-between outbound calls.
last_namestring- The last name of the user. (maximum 255 characters.)
lockedboolean- A boolean value whether the user is locked out of the application.
mailbox_error_email_enabledboolean- A boolean value whether the user's mailbox error emails are enabled.
mailbox_idinteger- The default mailbox associated with the user. Provide the numeric Outreach ID.
mailboxes_idsarray- All mailboxes associated with the user. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
meeting_engagement_notification_enabledboolean- A boolean value whether the user's meeting engagement notifications are enabled.
notifications_enabledboolean- A boolean value whether the user's notifications are enabled.
oce_click_to_dial_everywhereboolean- A boolean value indicating if phone calls will launch a call from Outreach (Salesforce, Github, Gmail, LinkedIn, and Twitter).
oce_gmail_toolbarboolean- A boolean value indicating whether the Outreach Gmail toolbar is enabled.
oce_gmail_tracking_statestring- The user's current email tracking settings when using Outreach Everywhere with GMail. (maximum 255 characters.)
oce_salesforce_email_decoratingboolean- A boolean value indicating if emails are enabled in Outreach Everywhere with Salesforce.
oce_salesforce_phone_decoratingboolean- A boolean value indicating if phone calls are enabled in Outreach Everywhere with Salesforce.
oce_universal_task_flowboolean- A boolean value indicating whether Outreach Everywhere universal task flow is enabled.
oce_window_modeboolean- A boolean value indicating whether Outreach Everywhere window mode is enabled.
opportunities_view_idinteger- The default smart view to load on the opportunity index view.
phone_country_codestring- The country code of the user's phone. (maximum 2 characters.)
phone_numberstring- The telephone number of the user's phone.
phone_typestring- The user's type of telephone for outbound calls. Must be either "bridge" or "voip". (maximum 255 characters.)
plugin_alert_notification_enabledboolean- A boolean value whether the user's plugin related error notifications are enabled.
preferred_voice_regionstring- A string that represents Twilio data center used to connect to Twilio. (maximum 255 characters.)
prefers_local_presenceboolean- A boolean value whether the user prefers that a voice call comes from a local phone number.
profile_idinteger- The user's profile in Outreach. Provide the numeric Outreach ID.
prospects_view_idinteger- The default smart view to load on the prospect index view.
recipients_idsarray- Recipients that will be included by default in all emails composed by user. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
reports_team_perf_view_idinteger- The default smart view to load on the team performance reports view.
reports_view_idinteger- The default smart view to load on the reports view.
role_idinteger- The role associated with the user. Provide the numeric Outreach ID.
scim_external_idstring- The ID from the SCIM provisioning service used to create the user. (maximum 255 characters.)
scim_sourcestring- The name of the SCIM provisioning source used to create the user. (maximum 255 characters.)
sender_notifications_excludedboolean- A boolean value whether the user's sender notifications are excluded.
tasks_view_idinteger- The default smart view to load on the tasks index view.
teams_idsarray- The teams the user belongs to. Provide the numeric Outreach IDs as an array. Provide the numeric Outreach ID.
teams_view_idinteger- The default smart view to load on the teams index view.
texting_email_notificationsboolean- A boolean value whether to send the user email notifications when a text message is missed.
titlestring- The user's job title (e.g. "Staff Accountant"). (maximum 255 characters.)
unknown_reply_email_enabledboolean- A boolean value whether the user's unknown reply emails are enabled.
usernamestring- A reader friendly unique identifier of the user. (maximum 255 characters.)
users_view_idinteger- The default smart view to load on the users index view.
voicemail_notification_enabledboolean- A boolean value whether the user's voicemail notifications are enabled.
weekly_digest_email_enabledboolean- A boolean value whether the user's weekly digest email are enabled.
outreach_webhook_updateUpdate an existing webhook's URL, subscribed event type, resource type, or signing secret in Outreach.WriteUpdate Webhook
Update an existing webhook's URL, subscribed event type, resource type, or signing secret in Outreach.
- Idempotent
Inputs
webhook_idintegerrequired- The unique identifier of the webhook to update
actionstring- New event action to subscribe to (e.g., created, updated, deleted)
resource_typestring- New resource type to subscribe to events for (e.g., prospect, account, sequenceState)
secretstring- New secret string used to sign webhook payloads for verification
urlstring- New HTTPS URL to receive webhook event payloads
outreach_webhooks_createCreate a new webhook in Outreach to receive event notifications at a specified URL.WriteCreate Webhook
Create a new webhook in Outreach to receive event notifications at a specified URL. Outreach will POST event payloads to the provided URL when subscribed events occur.
Inputs
urlstringrequired- The HTTPS URL to receive webhook event payloads
actionstring- The event action to subscribe to (e.g., created, updated, deleted)
resource_typestring- The resource type to subscribe to events for (e.g., prospect, account, sequenceState)
secretstring- A secret string used to sign webhook payloads for verification
outreach_account_notes_deleteDelete a account note in Outreach by its ID.DestructiveDelete Account Note
Delete a account note in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_account_notes_update to change it instead. Requires the numeric account note id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
account_note_idintegerrequired- Numeric Outreach ID of the account note. Find it with outreach_account_notes_list.
outreach_accounts_deletePermanently delete an account from Outreach by ID.DestructiveDelete Account
Permanently delete an account from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
account_idintegerrequired- The unique identifier of the account to delete
outreach_call_deletePermanently delete a logged call record from Outreach by ID.DestructiveDelete Call
Permanently delete a logged call record from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
call_idintegerrequired- The unique identifier of the call to delete
outreach_call_dispositions_deleteDelete a call disposition in Outreach by its ID.DestructiveDelete Call Disposition
Delete a call disposition in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_call_dispositions_update to change it instead. Requires the numeric call disposition id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
call_disposition_idintegerrequired- Numeric Outreach ID of the call disposition. Find it with outreach_call_dispositions_list.
outreach_call_purposes_deleteDelete a call purpose in Outreach by its ID.DestructiveDelete Call Purpose
Delete a call purpose in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_call_purposes_update to change it instead. Requires the numeric call purpose id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
call_purpose_idintegerrequired- Numeric Outreach ID of the call purpose. Find it with outreach_call_purposes_list.
outreach_compliance_requests_createSubmit a compliance request in Outreach to process the personal data of one prospect or recipient; today only a delete request is supported, so this permanently removes that person's data.DestructiveCreate Compliance Request
Submit a compliance request in Outreach to process the personal data of one prospect or recipient; today only a delete request is supported, so this permanently removes that person's data. Returns the batch compliance request id (batch_compliance_request_id) that tracks the request. Use this for a data-erasure (GDPR-style) request; use outreach_compliance_requests_list or outreach_compliance_requests_get to check requests already submitted. Requires the requester's email address and the email address of the prospect or recipient, with the record type (Prospect or Recipient).
Inputs
object_typestringrequired- The type of record to process: 'Prospect', or 'Recipient' for an email address not associated with a prospect.one of
ProspectRecipient request_object_emailstringrequired- Email address of the prospect or recipient whose data is to be processed.
request_typestringrequired- The type of compliance request. Only 'Delete' is supported at this time.one of
Delete requester_emailstringrequired- Email address of the person making the compliance request.
outreach_content_categories_deleteDelete a content category in Outreach by its ID.DestructiveDelete Content Category
Delete a content category in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_content_categories_update to change it instead. Requires the numeric content category id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
content_category_idintegerrequired- Numeric Outreach ID of the content category. Find it with outreach_content_categories_list.
outreach_content_category_memberships_deleteDelete a content category membership in Outreach by its ID.DestructiveDelete Content Category Membership
Delete a content category membership in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Requires the numeric content category membership id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
content_category_membership_idintegerrequired- Numeric Outreach ID of the content category membership. Find it with outreach_content_category_memberships_list.
outreach_content_category_ownerships_deleteDelete a content category ownership in Outreach by its ID.DestructiveDelete Content Category Ownership
Delete a content category ownership in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Requires the numeric content category ownership id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
content_category_ownership_idintegerrequired- Numeric Outreach ID of the content category ownership. Find it with outreach_content_category_ownerships_list.
outreach_email_address_deletePermanently delete a prospect email address from Outreach by ID.DestructiveDelete Email Address
Permanently delete a prospect email address from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
email_address_idintegerrequired- The unique identifier of the email address to delete
outreach_favorites_deleteDelete a favorite in Outreach by its ID.DestructiveDelete Favorite
Delete a favorite in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Requires the numeric favorite id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
favorite_idintegerrequired- Numeric Outreach ID of the favorite. Find it with outreach_favorites_list.
outreach_mailbox_unlink_ews_master_accountUnlink the EWS (Exchange Web Services) master account from an Outreach mailbox.DestructiveUnlink Ews Master Account Mailbox
Unlink the EWS (Exchange Web Services) master account from an Outreach mailbox. Returns an empty response when the link is removed. Use this to disconnect a mailbox from its EWS master account; use outreach_mailbox_link_ews_master_account to connect one. Requires the mailbox id from outreach_mailboxes_list.
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
outreach_mailboxes_deleteDelete a mailbox in Outreach by its ID.DestructiveDelete Mailbox
Delete a mailbox in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_mailboxes_update to change it instead. Requires the numeric mailbox id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
mailbox_idintegerrequired- Numeric Outreach ID of the mailbox. Find it with outreach_mailboxes_list.
outreach_opportunities_deletePermanently delete an opportunity from Outreach by ID.DestructiveDelete Opportunity
Permanently delete an opportunity from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
opportunity_idintegerrequired- The unique identifier of the opportunity to delete
outreach_opportunity_prospect_roles_deleteDelete a opportunity prospect role in Outreach by its ID.DestructiveDelete Opportunity Prospect Role
Delete a opportunity prospect role in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_opportunity_prospect_roles_update to change it instead. Requires the numeric opportunity prospect role id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
opportunity_prospect_role_idintegerrequired- Numeric Outreach ID of the opportunity prospect role. Find it with outreach_opportunity_prospect_roles_list.
outreach_opportunity_stages_deleteDelete a opportunity stage in Outreach by its ID.DestructiveDelete Opportunity Stage
Delete a opportunity stage in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_opportunity_stages_update to change it instead. Requires the numeric opportunity stage id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
opportunity_stage_idintegerrequired- Numeric Outreach ID of the opportunity stage.
outreach_personas_deleteDelete a persona in Outreach by its ID.DestructiveDelete Persona
Delete a persona in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_personas_update to change it instead. Requires the numeric persona id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
persona_idintegerrequired- Numeric Outreach ID of the persona. Find it with outreach_personas_list.
outreach_phone_numbers_deleteDelete a phone number in Outreach by its ID.DestructiveDelete Phone Number
Delete a phone number in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_phone_numbers_update to change it instead. Requires the numeric phone number id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
phone_number_idintegerrequired- Numeric Outreach ID of the phone number. Find it with outreach_phone_numbers_list.
outreach_products_deleteDelete a product in Outreach by its ID.DestructiveDelete Product
Delete a product in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_products_update to change it instead. Requires the numeric product id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
product_idintegerrequired- Numeric Outreach ID of the product. Find it with outreach_products_list.
outreach_profiles_deleteDelete a profile in Outreach by its ID.DestructiveDelete Profile
Delete a profile in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_profiles_update to change it instead. Requires the numeric profile id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
profile_idintegerrequired- Numeric Outreach ID of the profile. Find it with outreach_profiles_list.
outreach_prospect_note_deleteDelete a prospect note from Outreach by ID.DestructiveDelete Prospect Note
Delete a prospect note from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
prospect_note_idintegerrequired- The unique identifier of the prospect note to delete
outreach_prospects_deletePermanently delete a prospect from Outreach by ID.DestructiveDelete Prospect
Permanently delete a prospect from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
prospect_idintegerrequired- The unique identifier of the prospect to delete
outreach_purchases_deleteDelete a purchase in Outreach by its ID.DestructiveDelete Purchase
Delete a purchase in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_purchases_update to change it instead. Requires the numeric purchase id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
purchase_idintegerrequired- Numeric Outreach ID of the purchase. Find it with outreach_purchases_list.
outreach_recipients_deleteDelete a recipient in Outreach by its ID.DestructiveDelete Recipient
Delete a recipient in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_recipients_update to change it instead. Requires the numeric recipient id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
recipient_idintegerrequired- Numeric Outreach ID of the recipient. Find it with outreach_recipients_list.
outreach_roles_deleteDelete a role in Outreach by its ID.DestructiveDelete Role
Delete a role in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_roles_update to change it instead. Requires the numeric role id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
role_idintegerrequired- Numeric Outreach ID of the role. Find it with outreach_roles_list.
outreach_rulesets_deleteDelete a ruleset in Outreach by its ID.DestructiveDelete Ruleset
Delete a ruleset in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_rulesets_update to change it instead. Requires the numeric ruleset id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
ruleset_idintegerrequired- Numeric Outreach ID of the ruleset. Find it with outreach_rulesets_list.
outreach_sequence_states_deleteRemove a prospect from a sequence by deleting the sequence state record.DestructiveRemove Prospect from Sequence
Remove a prospect from a sequence by deleting the sequence state record. This action cannot be undone.
- Idempotent
Inputs
sequence_state_idintegerrequired- The unique identifier of the sequence state to delete
outreach_sequence_templates_deleteDelete a sequence template in Outreach by its ID.DestructiveDelete Sequence Template
Delete a sequence template in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_sequence_templates_update to change it instead. Requires the numeric sequence template id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
sequence_template_idintegerrequired- Numeric Outreach ID of the sequence template. Find it with outreach_sequence_templates_list.
outreach_sequences_deletePermanently delete a sequence from Outreach by ID.DestructiveDelete Sequence
Permanently delete a sequence from Outreach by ID. This action cannot be undone and will remove all associated sequence steps.
- Idempotent
Inputs
sequence_idintegerrequired- The unique identifier of the sequence to delete
outreach_snippet_deletePermanently delete a reusable email snippet from Outreach by ID.DestructiveDelete Snippet
Permanently delete a reusable email snippet from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
snippet_idintegerrequired- The unique identifier of the snippet to delete
outreach_stages_deleteDelete a stage in Outreach by its ID.DestructiveDelete Stage
Delete a stage in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_stages_update to change it instead. Requires the numeric stage id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
stage_idintegerrequired- Numeric Outreach ID of the stage. Find it with outreach_stages_list.
outreach_task_dispositions_deleteDelete a task disposition in Outreach by its ID.DestructiveDelete Task Disposition
Delete a task disposition in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_task_dispositions_update to change it instead. Requires the numeric task disposition id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
task_disposition_idintegerrequired- Numeric Outreach ID of the task disposition. Find it with outreach_task_dispositions_list.
outreach_task_purposes_deleteDelete a task purpose in Outreach by its ID.DestructiveDelete Task Purpose
Delete a task purpose in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_task_purposes_update to change it instead. Requires the numeric task purpose id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
task_purpose_idintegerrequired- Numeric Outreach ID of the task purpose. Find it with outreach_task_purposes_list.
outreach_tasks_deletePermanently delete a task from Outreach by ID.DestructiveDelete Task
Permanently delete a task from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
task_idintegerrequired- The unique identifier of the task to delete
outreach_teams_deleteDelete a team in Outreach by its ID.DestructiveDelete Team
Delete a team in Outreach by its ID. Treat this as irreversible. Returns an empty response (HTTP 204) when the record is removed. Use this only when the record must be removed. Use outreach_teams_update to change it instead. Requires the numeric team id; deleting removes it for every user of the Outreach org.
- Idempotent
Inputs
team_idintegerrequired- Numeric Outreach ID of the team. Find it with outreach_teams_list.
outreach_templates_deletePermanently delete an email template from Outreach by ID.DestructiveDelete Template
Permanently delete an email template from Outreach by ID. This action cannot be undone.
- Idempotent
Inputs
template_idintegerrequired- The unique identifier of the template to delete
outreach_webhooks_deletePermanently delete a webhook from Outreach by ID.DestructiveDelete Webhook
Permanently delete a webhook from Outreach by ID. Outreach will stop sending event notifications to the associated URL.
- Idempotent
Inputs
webhook_idintegerrequired- The unique identifier of the webhook to delete
No tools match.