Outreach
API integration

list_all_outreach_users

List Outreach users. Returns each user record with type, id, attributes (email, firstName, lastName, locked, createdAt, updatedAt), and relationships.

get_single_outreach_user_by_id

Get a single Outreach user by id. Returns: attributes, id, relationships, type. Required: id.

delete_a_outreach_user_by_id

Lock an Outreach user account by id (soft delete via the locked attribute). Returns: attributes, id, relationships, type. Required: id.

update_a_outreach_user_by_id

Update an existing Outreach user by id. Returns: attributes, id, relationships, type. Required: id, data.type, data.id.

create_a_outreach_user

Create a new Outreach user, sending an email invitation by default (suppress via meta.sendInvite=false). Returns: attributes, id, relationships, type. Required: data.type, data.attributes.email.

list_all_outreach_accounts

List a collection of Outreach accounts. Returns each account record with type, id, attributes (name, domain, companyType, customId, createdAt, updatedAt), and relationships (prospects).

get_single_outreach_account_by_id

Get a single Outreach account by id. Returns the account resource with type, id, attributes (name, domain, companyType, customId, createdAt, updatedAt), and relationships (prospects). Required: id.

create_a_outreach_account

Create a new account in Outreach. Returns the created account resource with type, id, attributes (name, domain, companyType, customId, createdAt, updatedAt), and relationships (prospects). Required: data.type.

update_a_outreach_account_by_id

Update an existing Outreach account by id. Returns the updated account resource with type, id, attributes (name, domain, companyType, customId, createdAt, updatedAt), and relationships (prospects). Required: id, data.type, data.id.

delete_a_outreach_account_by_id

Delete an Outreach account by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_prospects

List a collection of prospects in Outreach. Returns each prospect with type, id, attributes (emails, firstName, lastName, title, company, externalId, createdAt, updatedAt), and relationships (account, stage, owner, mailings).

get_single_outreach_prospect_by_id

Get a single prospect in Outreach by id. Returns the data object containing the prospect's type, id, attributes (emails, firstName, lastName, title, company, externalId, createdAt, updatedAt), and relationships (account, stage, owner, mailings). Required: id.

create_a_outreach_prospect

Create a new prospect in Outreach. Returns the data object containing the created prospect's type, id, attributes (emails, firstName, lastName, title, company, externalId, createdAt, updatedAt), and relationships (account, stage, owner, mailings). Required: data (including type).

update_a_outreach_prospect_by_id

Update an existing prospect in Outreach. Returns the data object containing the prospect's type, id, attributes (firstName, lastName, company, emails), and relationships. Required: id, data, data.type, data.id.

delete_a_outreach_prospect_by_id

Delete an existing prospect in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_calls

List calls in Outreach. Returns each call with type, id, attributes (direction, outcome, note, answeredAt, completedAt, createdAt, updatedAt), and relationships to prospect, task, and user.

get_single_outreach_call_by_id

Get a single call in Outreach by id. Returns: data. Required: id.

create_a_outreach_call

Log a new external call in Outreach. Direction must be inbound or outbound and outcome must be completed or no_answer. Returns: data. Required: data, type, attributes, relationships, direction, outcome, prospect, user.

delete_a_outreach_call_by_id

Delete a call in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_mailing

List Outreach mailings. Returns a collection of mailing records, each containing type, id, attributes, and relationships. Mailings provide delivery information including bounce, delivery, open, and reply events.

get_single_outreach_mailing_by_id

Get a single Outreach mailing by id. Returns the mailing record including its type, id, attributes, and relationships. Required: id.

create_a_outreach_mailing

Create a new Outreach mailing. Returns the created mailing record including its type, id, attributes, and relationships. The request body follows the JSON:API format with a data wrapper containing type, attributes, and relationships. Required: id.

list_all_outreach_events

List Outreach events, which are logged when various activities occur throughout the platform. Returns: attributes, id, relationships, type.

get_single_outreach_event_by_id

Get a single Outreach event by id. Returns: data. Required: id.

create_a_outreach_event

Create a new Outreach event. Returns the created event including type, id, name, createdAt, and updatedAt. Required: data.type.

list_all_outreach_opportunities

List a collection of opportunities in Outreach. Returns each opportunity record with type, id, attributes, and relationships.

get_single_outreach_opportunity_by_id

Get a single opportunity in Outreach by id. Returns the opportunity record including type, id, attributes, and relationships. Required: id.

create_a_outreach_opportunity

Create a new opportunity in Outreach. Returns the created opportunity record including type, id, attributes, and relationships. Required: data with type.

update_a_outreach_opportunity_by_id

Update an existing opportunity in Outreach by id. Returns the updated opportunity record including type, id, attributes, and relationships. Required: id, data with type and id.

delete_a_outreach_opportunity_by_id

Delete an existing opportunity in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_opportunity_stages

List a collection of opportunity stages in Outreach. Returns each stage's id, type, attributes, and relationships.

get_single_outreach_opportunity_stage_by_id

Get a single opportunity stage by id in Outreach. Returns the stage's id, type, attributes, and relationships. Required: id.

create_a_outreach_opportunity_stage

Create a new opportunity stage in Outreach. Returns the created stage's id, type, attributes, and relationships. Required: data.type.

update_a_outreach_opportunity_stage_by_id

Update an opportunity stage in Outreach by id. Returns the updated opportunity stage object including id, type, attributes, and relationships. Required: id.

delete_a_outreach_opportunity_stage_by_id

Delete an opportunity stage in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_tasks

List tasks in Outreach. Returns a collection of task objects with type, id, attributes (including action, state, completedAt, note, dueAt, task_type, createdAt, updatedAt), and relationships (owner, prospect, opportunity, template).

get_single_outreach_task_by_id

Get a single task in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_task

Create a new task in Outreach. Returns: attributes, id, relationships, type. Required: data.type.

update_a_outreach_task_by_id

Update a task in Outreach by id. Returns: attributes, id, relationships, type. Required: id, data.type, data.id.

delete_a_outreach_task_by_id

Delete a task in Outreach by id. Returns an empty 204 response on success. Required: id.

outreach_tasks_snooze

Snooze an Outreach task by setting its dueAt a day later than now or the existing dueAt, whichever is later. Returns the task data object including type, id, attributes (action, state, dueAt, note, completed, completedAt, createdAt, updatedAt), and relationships. Required: id.

outreach_tasks_advance

Advance the sequence state of an Outreach task to the next step in its sequence. Only sequence-step task types (call, email, LinkedIn, SMS, task) can be advanced. Returns the task data object including type, id, attributes (action, state, dueAt, note, completed, completedAt, createdAt, updatedAt), and relationships. Required: id.

outreach_tasks_deliver

Schedule the mailing associated with an Outreach task for delivery, if possible. Returns the task data object including type, id, attributes (action, state, dueAt, note, completed, completedAt, createdAt, updatedAt), and relationships. Required: id.

outreach_tasks_reschedule

Reschedule an Outreach task by setting a new dueAt time. Returns the task data object including type, id, attributes (action, state, dueAt, note, completed, completedAt, createdAt, updatedAt), and relationships. Required: id, actionParams.dueAt.

outreach_tasks_update_note

Update the note on an Outreach task. Returns the task data object including type, id, attributes (action, state, dueAt, note, completed, completedAt, createdAt, updatedAt), and relationships. Required: id, actionParams.note.

outreach_tasks_update_opportunity_association

Update the opportunity association of an Outreach task. Returns the task object including its type, id, attributes (action, state, completed, completedAt), and relationships (prospect, owner). Required: id, actionParams.opportunityAssociation.

outreach_tasks_reassign_owner

Reassign the owner of an Outreach task to a new user. Returns the task object including its type, id, attributes (action, state, completed, completedAt), and relationships (prospect, owner). Required: id, actionParams.ownerId.

outreach_tasks_mark_complete

Mark an Outreach task as complete, optionally attaching a completion note and specifying how to finish the associated sequence state. Returns the task object including its type, id, attributes (action, state, completed, completedAt), and relationships (prospect, owner). Required: id.

outreach_tasks_log_meet_in_person

Mark a meet in-person Outreach task as complete with a specified task disposition and purpose. Returns the task data object containing the task's id, type, attributes (action, state, completed, completedAt, note, task_type), and relationships. Required: task_id. When actionParams is supplied, taskDispositionId within it is required.

list_all_outreach_audits

List audit records in Outreach. Returns a collection of JSON:API resource objects with type, id, attributes, and relationships. Up to 50 records per page.

list_all_outreach_roles

List a collection of Outreach roles. Returns each role record with type, id, attributes, and relationships.

get_single_outreach_role_by_id

Get a single Outreach role by id. Returns the role record with type, id, attributes, and relationships. Required: id.

delete_a_outreach_role_by_id

Delete an Outreach role by id. Returns an empty 204 response on success. Required: id.

create_a_outreach_role

Create a new role in Outreach. Returns the created role object including its type, id, attributes, and relationships. Required: data.type.

update_a_outreach_role_by_id

Update an existing Outreach role by id. Returns the updated role object including its type, id, attributes, and relationships. Required: id, data.type, data.id.

list_all_outreach_profiles

List profiles in Outreach. Returns: attributes, id, relationships, type. Up to 50 results per page.

get_single_outreach_profile_by_id

Get a single Outreach profile by id. Returns the profile resource object including its type, id, attributes, and relationships. Required: id.

create_a_outreach_profile

Create a new profile in Outreach. Returns the created profile object including its id, type, attributes, and relationships. Required: data.

delete_a_outreach_profile_by_id

Delete a profile in Outreach by id. Returns an empty 204 response on success. Required: id.

update_a_outreach_profile_by_id

Update a profile in Outreach by id. Returns the updated profile object including its id, type, attributes, and relationships. Required: id, data.

list_all_outreach_account_notes

List a collection of account notes in Outreach. Returns each note with its type, id, attributes (including createdAt and updatedAt), and relationships.

get_single_outreach_account_note_by_id

Get a single account note in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_account_note

Create a new account note in Outreach. Returns the created note with its type, id, attributes (including createdAt and updatedAt), and relationships.

update_a_outreach_account_note_by_id

Update an existing account note in Outreach. Returns the updated note with its type, id, attributes (including createdAt and updatedAt), and relationships. Required: id, data.type, data.id.

delete_a_outreach_account_note_by_id

Delete an account note in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_audit_logs

List audit logs in Outreach. Returns: attributes, id, relationships, type.

list_all_outreach_batch_items

List batch items in Outreach. Returns: attributes, id, relationships, type. Batch items represent individual records processed during a bulk upsert, with data containing the original JSON resource object and itemId being the Outreach ID of the resulting record.

get_single_outreach_batch_item_by_id

Get a single batch item by id in Outreach. Returns: attributes, id, relationships, type. The data attribute contains the original JSON resource object and itemId is the Outreach ID of the processed record. Required: id.

list_all_outreach_batches

List batches in Outreach. Returns each batch with type, id, attributes (action, state, confirmCount, total, failures, createdAt, updatedAt), relationships, and links.

get_single_outreach_batch_by_id

Get a single Outreach batch by id. Returns: attributes, id, relationships, type, links. Required: id.

outreach_batches_cancel

Cancel an Outreach batch. The batch state moves to canceled and item processing stops if started. Returns: attributes, id, relationships, type, links. Required: batche_id.

outreach_batches_confirm

Confirm an Outreach batch to trigger processing. When confirmedCountRequired is true, supply confirmedCount via actionParams. Returns: attributes, id, relationships, type, links. Required: batche_id.

outreach_batches_account_add_tags

Add tags to Outreach accounts targeted by query parameters (default: ALL) using a tags array in the request body. Returns: attributes, id, relationships, type, links. Required: tags.

outreach_batches_accounts_add_assignments

Add assignments to Outreach accounts targeted by query filter (default: ALL) using the userIds array in the request body. Returns the created batch object including id, type, attributes (state, action, total, failures, createdAt, updatedAt), relationships, and links.

outreach_batches_accounts_assign_owner

Assign an owner to Outreach accounts targeted by query filter (default: ALL) using the ownerId in the request body. Returns the created batch object including id, type, attributes (state, action, total, failures, createdAt, updatedAt), relationships, and links.

outreach_batches_accounts_bulk_modify

Modify Outreach accounts targeted by query filter (default: ALL) using field name/value pairs in the request body. Supports both multi-field (arbitrary key/value pairs) and single-field (fieldName/fieldValue) modification modes. Returns the created batch object including id, type, attributes (state, action, total, failures, createdAt, updatedAt), relationships, and links.

outreach_batches_accounts_destroy_all

Delete Outreach accounts targeted by query filter (default: ALL). Returns the created batch object including id, type, attributes (state, action, total, failures, createdAt, updatedAt), relationships, and links.

outreach_batches_accounts_remove_all_assignments

Remove all assignments from Outreach accounts targeted by query filter (default: ALL). Returns the created batch object including id, type, attributes (state, action, total, failures, createdAt, updatedAt), relationships, and links.

outreach_batches_accounts_remove_assignments

Remove assignments from Outreach accounts in bulk using a list of user IDs, targeting accounts by filter or specific IDs. Returns: attributes, id, relationships, type, links.

outreach_batches_accounts_remove_tags

Remove tags from Outreach accounts in bulk using a list of tag strings, targeting accounts by filter or specific IDs. Returns: attributes, id, relationships, type, links.

outreach_batches_custom_object_bulk_delete

Delete custom objects of a specified type in bulk in Outreach, targeting records by filter or specific IDs. Returns: attributes, id, relationships, type, links. Required: objectName.

outreach_batches_custom_object_bulk_modify

Modify custom objects of a specified type in bulk in Outreach, updating field values on records targeted by filter or specific IDs. Returns: attributes, id, relationships, type, links. Required: objectName.

outreach_batches_prospects_add_assignments

Add assignments to Outreach prospects in bulk using a list of user IDs, targeting prospects by filter or specific IDs. Returns: attributes, id, relationships, type, links.

outreach_batches_prospects_add_tags

Add tags to prospects in Outreach via a bulk batch action. Returns a batch object including id, type, attributes (action, state, confirmCount, total, failures, pending), and links. If no filter or ids are provided, all prospects are targeted by default.

outreach_batches_prospects_add_to_sequence

Add prospects to a sequence in Outreach via a bulk batch action. Returns a batch object including id, type, attributes (action, state, confirmCount, total, failures, pending), and links. If no filter or ids are provided, all prospects are targeted by default.

outreach_batches_prospects_assign_account

Assign an account to prospects in Outreach via a bulk batch action. Returns a batch object including id, type, attributes (action, state, confirmCount, total, failures, pending), and links. If no filter or ids are provided, all prospects are targeted by default.

outreach_batches_prospects_assign_opportunity

Assign an opportunity to prospects in Outreach via a bulk batch action. Returns a batch object including id, type, attributes (action, state, confirmCount, total, failures, pending), and links. If no filter or ids are provided, all prospects are targeted by default.

outreach_batches_prospects_assign_owner

Assign an owner to prospects in Outreach via a bulk batch action. Returns a batch object including id, type, attributes (action, state, confirmCount, total, failures, pending), and links. If no filter or ids are provided, all prospects are targeted by default.

outreach_batches_prospects_bulk_modify

Bulk modify prospects in Outreach by applying field-value pairs to prospects targeted by query filters (defaults to ALL). Returns a batch object including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_destroy_all

Bulk delete prospects in Outreach targeted by query filters (defaults to ALL). Returns a batch object including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_finish_all

Bulk finish prospect sequences in Outreach for prospects targeted by query filters (defaults to ALL). Returns a batch object including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_pause_all

Bulk pause prospect sequences in Outreach for prospects targeted by query filters (defaults to ALL). Returns a batch object including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_remove_all_assignments

Bulk remove all assignments from prospects in Outreach targeted by query filters (defaults to ALL). Returns a batch object including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_remove_assignments

Remove assignments from prospects in Outreach via a bulk batch action, targeting all prospects by default or those matching a filter. Returns the batch record including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

outreach_batches_prospects_remove_tags

Remove tags from prospects in Outreach via a bulk batch action, targeting all prospects by default or those matching a filter. Returns the batch record including id, type, attributes (action, state, total, failures, pending, createdAt, updatedAt), relationships, and links.

list_all_outreach_call_dispositions

List call dispositions in Outreach. Returns each disposition with type, id, attributes, and relationships.

get_single_outreach_call_disposition_by_id

Get a single call disposition by id in Outreach. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_call_disposition

Create a new call disposition in Outreach. Returns the created call disposition with type, id, attributes, and relationships. Required: data.type.

update_a_outreach_call_disposition_by_id

Update a call disposition by id in Outreach. Returns the updated call disposition with type, id, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_call_disposition_by_id

Delete an existing call disposition by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_call_purposes

List call purposes in Outreach. Returns a collection of call purpose records, each with type, id, attributes (including createdAt and updatedAt), and relationships.

get_single_outreach_call_purpose_by_id

Get a single call purpose by id in Outreach. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_call_purpose

Create a new call purpose in Outreach. Returns the created call purpose record including type, id, attributes (including createdAt and updatedAt), and relationships. Required: data.type.

update_a_outreach_call_purpose_by_id

Update an existing call purpose by id in Outreach. Returns the updated call purpose record including type, id, attributes (including createdAt and updatedAt), and relationships. Required: id, data.type, data.id.

delete_a_outreach_call_purpose_by_id

Delete an existing call purpose by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_compliance_requests

List compliance requests in Outreach for tracking GDPR/CCPA prospect deletion requests. Returns: attributes, id, relationships, type. Filter by batch_compliance_request to track a specific submission's processing status.

get_single_outreach_compliance_request_by_id

Get a single compliance request in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_compliance_request

Create a new compliance request in Outreach to permanently delete a prospect for CCPA/GDPR compliance. Processing is asynchronous and triggers a batch of tasks. Returns: batch_compliance_request_id. Required: type, requester_email, request_type, object_type, request_object_email.

list_all_outreach_content_categories

List all content categories in Outreach. Returns a collection of content category records, each including type, id, attributes, and relationships.

create_a_outreach_content_category

Create a new content category in Outreach. Returns the created content category including its type, id, attributes, and relationships. Required: data.

delete_a_outreach_content_category_by_id

Delete a content category by id in Outreach. Returns an empty 204 response on success. Required: id.

get_single_outreach_content_category_by_id

Get a single content category by id in Outreach. Returns the content category including type, id, attributes, and relationships. Required: id.

update_a_outreach_content_category_by_id

Update an existing content category by id in Outreach. Returns the updated content category including type, id, attributes, and relationships. Required: id, data.

list_all_outreach_content_category_memberships

List content category memberships in Outreach. Returns a collection of membership records, each with type, id, attributes, relationships, and links.

create_a_outreach_content_category_membership

Create a new content category membership in Outreach. The request body follows JSON:API format with type, attributes, and relationships. Returns the created membership with type, id, attributes, relationships, and links. Required: data.

get_single_outreach_content_category_membership_by_id

Get a single content category membership in Outreach by id. Returns: attributes, id, relationships, type, links. Required: id.

delete_a_outreach_content_category_membership_by_id

Delete an existing content category membership in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_content_category_ownerships

List a collection of content category ownerships in Outreach. Returns: attributes, id, relationships, type, links.

create_a_outreach_content_category_ownership

Create a new content category ownership in Outreach. Returns the created resource including type, id, attributes, relationships, and links. Required: data.

delete_a_outreach_content_category_ownership_by_id

Delete an existing content category ownership in Outreach by id. Returns an empty 204 response on success. Required: id.

create_a_outreach_custom_duty

Create a new custom duty in Outreach. Returns the created custom duty object including its type, id, attributes (with createdAt and updatedAt timestamps), relationships, and links. Required: data.type and data.attributes. The specific attribute fields depend on the custom duty schema configured in your Outreach instance; consult the /api/v2/schema endpoint for the field-level breakdown.

list_all_outreach_duties

List a collection of duties in Outreach. Returns each duty as a JSON:API resource object including type, id, attributes, and relationships. Up to 50 records per page.

list_all_outreach_email_addresses

List email addresses in Outreach. Returns a collection of email address records each containing id, type, attributes, and relationships. Results are returned up to 50 per page.

create_a_outreach_email_address

Create a new email address in Outreach. Returns the created email address record including its id, type, attributes, and relationships. Required: data.type.

get_single_outreach_email_address_by_id

Get a single email address in Outreach by id. Returns the email address record including its id, type, attributes, and relationships. Required: id.

update_a_outreach_email_address_by_id

Update an existing email address in Outreach by id. Returns the updated email address record including its id, type, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_email_address_by_id

Delete an existing email address in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_favorites

List favorites in Outreach. Returns a collection of favorite resource objects, each including type, id, attributes, relationships, and links. Up to 50 per page.

create_a_outreach_favorite

Create a new favorite in Outreach. Returns the created favorite resource object including type, id, attributes, relationships, and links. Required: data.

get_single_outreach_favorite_by_id

Get a single favorite in Outreach by id. Returns the favorite resource object including type, id, attributes, relationships, and links. Required: id.

delete_a_outreach_favorite_by_id

Delete an existing favorite in Outreach by id. Returns an empty 204 response on success. Required: id.

get_single_outreach_import_by_id

Get an Outreach import record by id. Returns the import object including its id, type, and attributes such as state, fileName, dupeMethod, and createdAt. Required: id.

outreach_imports_accounts_import

Import an uploaded file into Outreach's accounts table. Accounts are matched by customId; duplicate records are handled according to dupeMethod. Returns the created import object including id, type, and attributes.

outreach_imports_bulk_upsert

Sync multiple Outreach API v2 objects to Outreach tables via bulk upsert. Uniqueness is determined by each record's data.id; duplicate records are handled according to dupeMethod. Returns the created import object including id, type, and attributes.

outreach_imports_custom_object_bulk_upsert

Bulk upsert records of a custom object in Outreach. Uniqueness is determined by each record's data.id attribute; the dupeMethod controls how existing records are handled during processing. Returns the created import object including id, type, and attributes.

outreach_imports_generate_upload_link

Generate a pre-signed upload link for a file import in Outreach. Returns: attributes, type.

outreach_imports_prospects_import

Import an uploaded file of prospects into Outreach's prospects table. Prospects use `externalId` as the unique field; if matching records already exist the specified `dupeMethod` is applied. Returns the created import record including its id, type, and attributes.

outreach_imports_validate_upload

Validate an uploaded file in Outreach before importing it. Returns: attributes, type, id. Required: actionParams.hash, actionParams.storageKey.

list_all_outreach_kaia_recordings

List Kaia recordings in Outreach. Returns a collection of recording objects, each with id, type, attributes, relationships, and links.

get_single_outreach_kaia_recording_by_id

Get a single Kaia recording by id in Outreach. Returns the recording object including its id, type, attributes, relationships, and links. Required: id.

create_a_outreach_kaia_voice_import

Create a new Kaia Voice Import in Outreach by submitting a JSON:API document with a data object containing type, attributes, and relationships. Returns the created kaiaVoiceImport record including its id, type, attributes, relationships, and links. Required: data (containing type and attributes).

list_all_outreach_mail_aliases

List a collection of mail aliases in Outreach. Returns each mail alias as a JSON:API resource object including its type, id, attributes, relationships, and links.

get_single_outreach_mail_alias_by_id

Get a single mail alias by id in Outreach. Returns the mail alias as a JSON:API resource object including its type, id, attributes, relationships, and links. Required: id.

list_all_outreach_mailboxes

List a collection of Outreach mailboxes. Returns each mailbox resource including its type, id, attributes, and relationships.

create_a_outreach_mailbox

Create a new Outreach mailbox by submitting a JSON:API resource object. Returns the created mailbox including its type, id, attributes, and relationships. Required: data.

get_single_outreach_mailbox_by_id

Get a single Outreach mailbox by id. Returns the mailbox resource including its type, id, attributes, and relationships. Required: id.

update_a_outreach_mailbox_by_id

Update an existing Outreach mailbox by id. Returns the updated mailbox including its type, id, attributes, and relationships. Required: id, data (with type and id).

delete_a_outreach_mailbox_by_id

Delete an Outreach mailbox by id. Returns an empty 204 response on success. Required: id.

outreach_mailboxes_link_ews_master_account

Link an Outreach mailbox with an EWS master account. Returns an empty 200 response on success. Required: mailbox_id.

outreach_mailboxes_test_send

Test if sending emails works from an Outreach mailbox. Returns the mailbox object including id and type. Required: mailbox_id.

outreach_mailboxes_test_sync

Test if syncing emails works from an Outreach mailbox. Returns the mailbox object including id and type. Required: mailbox_id.

outreach_mailboxes_unlink_ews_master_account

Unlink an EWS master account from an Outreach mailbox. Returns an empty 200 response on success. Required: mailbox_id.

create_a_outreach_mailing

Create a new mailing in Outreach by providing mailing attributes and/or relationships. Returns the created mailing object including its id, type, attributes, and relationships. Required: data (including type).

list_all_outreach_opportunity_prospect_roles

List opportunity prospect roles in Outreach. Returns: attributes, id, relationships, type.

create_a_outreach_opportunity_prospect_role

Create a new opportunity prospect role in Outreach. Returns the created role with type, id, attributes (including createdAt and updatedAt), and relationships. Required: data (with type).

get_single_outreach_opportunity_prospect_role_by_id

Get a single opportunity prospect role in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

update_a_outreach_opportunity_prospect_role_by_id

Update an existing opportunity prospect role in Outreach by id. Returns the updated role with type, id, attributes (including createdAt and updatedAt), and relationships. Required: id, data (with type and id).

delete_a_outreach_opportunity_prospect_role_by_id

Delete an existing opportunity prospect role in Outreach by id. Returns an empty 204 response on success. Required: id.

get_single_outreach_org_setting_by_id

Get a single Outreach org setting by id. Returns: attributes, id, relationships, type. Required: id.

update_a_outreach_org_setting_by_id

Update an Outreach org setting by id. Returns the updated org setting including its type, id, attributes, and relationships. Required: id, data.type, and data.id.

list_all_outreach_personas

List personas in Outreach. Returns a collection of persona objects each including type, id, attributes, and relationships.

get_single_outreach_persona_by_id

Get a single persona by id in Outreach. Returns the persona object including type, id, attributes, and relationships. Required: id.

create_a_outreach_persona

Create a new persona in Outreach. Returns the created persona object including type, id, attributes, and relationships. Required: data.type.

update_a_outreach_persona_by_id

Update a persona in Outreach by id. Returns the updated persona object including type, id, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_persona_by_id

Delete a persona in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_phone_numbers

List phone numbers in Outreach. Returns each record with type, id, attributes, and relationships.

get_single_outreach_phone_number_by_id

Get a single phone number in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_phone_number

Create a new phone number in Outreach. Returns: attributes, id, relationships, type. Required: data (containing type).

update_a_outreach_phone_number_by_id

Update a phone number in Outreach by id. Returns: attributes, id, relationships, type. Required: id, data (containing type and id).

delete_a_outreach_phone_number_by_id

Delete an existing phone number in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_products

List Outreach products. Returns each product's id, type, attributes (name, classification), and relationships (owner).

get_single_outreach_product_by_id

Get a single Outreach product by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_product

Create a new Outreach product. Returns: attributes, id, relationships, type. Required: data.

update_a_outreach_product_by_id

Update an existing Outreach product by id. Returns: attributes, id, relationships, type. Required: id, data (type and id required within data).

delete_a_outreach_product_by_id

Delete an Outreach product by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_prospect_notes

List prospect notes in Outreach. Returns: attributes, id, relationships, type. Up to 50 results per page.

get_single_outreach_prospect_note_by_id

Get a single prospect note by id in Outreach. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_prospect_note

Create a new prospect note in Outreach. Returns: attributes, id, relationships, type. Required: data.type.

update_a_outreach_prospect_note_by_id

Update an existing prospect note in Outreach. Returns: attributes, id, relationships, type. Required: id, data.type, data.id.

delete_a_outreach_prospect_note_by_id

Delete a prospect note by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_purchases

List a collection of purchases in Outreach. Returns each purchase resource object including its id, type, attributes (including createdAt and updatedAt), and relationships.

get_single_outreach_purchase_by_id

Get a single purchase in Outreach by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_purchase

Create a new purchase in Outreach. Returns the created purchase resource object including its id, type, attributes (including createdAt and updatedAt), and relationships. Required: data.

update_a_outreach_purchase_by_id

Update an existing purchase in Outreach by id. Returns the updated purchase resource object including its id, type, attributes (including createdAt and updatedAt), and relationships. Required: id, data (including type and id).

delete_a_outreach_purchase_by_id

Delete an existing purchase in Outreach by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_recipients

List a collection of recipients in Outreach. Returns: attributes, id, relationships, type.

get_single_outreach_recipient_by_id

Get a single recipient by id in Outreach. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_recipient

Create a new recipient in Outreach. Returns the created recipient including type, id, attributes, and relationships. Required: data.type.

update_a_outreach_recipient_by_id

Update an existing recipient by id in Outreach. Returns the updated recipient including type, id, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_recipient_by_id

Delete an existing recipient by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_rulesets

List a collection of rulesets in Outreach. Returns each ruleset's type, id, attributes (name, autoResumeOotoProspects, permitDuplicateProspects, createdAt, updatedAt), and relationships.

get_single_outreach_ruleset_by_id

Get a single Outreach ruleset by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_ruleset

Create a new ruleset in Outreach with a name and configuration attributes. Returns the created ruleset including type, id, attributes, and relationships. Required: data.type.

update_a_outreach_ruleset_by_id

Update an existing Outreach ruleset by id. Returns the updated ruleset including type, id, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_ruleset_by_id

Delete an Outreach ruleset by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_sequence_states

List outreach sequence states. Returns: attributes, id, relationships, type.

get_single_outreach_sequence_state_by_id

Get a single outreach sequence state by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_sequence_state

Create a new outreach sequence state to enroll a prospect in a sequence. Returns: attributes, id, relationships, type. Required: data (including type and relationships for prospect, sequence, and mailbox).

delete_a_outreach_sequence_state_by_id

Delete an outreach sequence state by id. Returns an empty 204 response on success. Required: id.

outreach_sequence_states_finish

Finish an active outreach sequence state, ending the prospect's engagement in the sequence. Returns: attributes, id, relationships, type. Required: sequence_state_id.

outreach_sequence_states_pause

Pause an active sequence state in Outreach. Returns the updated sequence state record including id, type, attributes (state, createdAt, stateChangedAt, updatedAt), and relationships (prospect, sequence, sequenceStep, mailbox). Required: sequence_state_id.

outreach_sequence_states_resume

Resume a paused sequence state in Outreach, returning it to active status. Returns the updated sequence state record including id, type, attributes (state, createdAt, stateChangedAt, updatedAt), and relationships (prospect, sequence, sequenceStep, mailbox). Required: sequence_state_id.

list_all_outreach_sequence_steps

List sequence steps in Outreach. Returns each step with type, id, attributes containing interval, stepType, date, createdAt, and updatedAt, plus relationships to its parent sequence.

get_single_outreach_sequence_step_by_id

Get a single Outreach sequence step by id. Returns the step's type, id, attributes (interval, stepType, date, createdAt, updatedAt), and relationships including its parent sequence. Required: id.

create_a_outreach_sequence_step

Create a new sequence step in Outreach. Specify a step type (auto_email, call, manual_email, or task) and an interval in minutes (or a date for date-based sequences), and associate the step with a sequence. Returns: attributes, id, relationships, type. Required: data.type, data.attributes.stepType, data.relationships.sequence.

update_a_outreach_sequence_step_by_id

Update an existing Outreach sequence step by id. Modify attributes such as stepType, interval, or date, and update relationships. Returns: attributes, id, relationships, type. Required: id, data.type, data.id.

list_all_outreach_sequence_templates

List Outreach sequence templates. Returns each template's type, id, attributes, and relationships including sequenceStep and template associations.

get_single_outreach_sequence_template_by_id

Get a single Outreach sequence template by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_sequence_template

Create a new sequence template in Outreach, associating it with a sequence step and a template. Returns: attributes, id, relationships, type. Required: data.

update_a_outreach_sequence_template_by_id

Update an existing Outreach sequence template by id. Returns: attributes, id, relationships, type. Required: id, data (including type and id).

delete_a_outreach_sequence_template_by_id

Delete an Outreach sequence template by id. Returns an empty 204 response on success. Required: id.

outreach_sequence_templates_activate

Activate an Outreach sequence template to enable the sequence step associated with it. Returns the sequence template object including id, type, attributes, and relationships. Required: sequence_template_id.

outreach_sequence_templates_deactivate

Deactivate an Outreach sequence template to disable the sequence step associated with it. Returns the sequence template object including id, type, attributes, and relationships. Required: sequence_template_id.

list_all_outreach_sequences

List Outreach sequences. Returns: attributes, id, relationships, type.

get_single_outreach_sequence_by_id

Get a single Outreach sequence by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_sequence

Create a new Outreach sequence. Returns: attributes, id, relationships, type. Required: data.type, data.attributes.name, data.attributes.sequenceType.

update_a_outreach_sequence_by_id

Update an Outreach sequence by id. Returns the updated sequence object including its id, type, attributes (name, description, sequenceType), and relationships (ruleset). Required: id, data.type, data.id.

delete_a_outreach_sequence_by_id

Delete an Outreach sequence by id. Returns an empty 204 response on success. Required: id.

outreach_sequences_activate

Activate an Outreach sequence by enabling it. Returns the updated sequence object including type, id, attributes (name, description, sequenceType), and relationships (ruleset). Required: sequence_id.

outreach_sequences_deactivate

Deactivate an Outreach sequence by disabling it. Returns the updated sequence object including type, id, attributes (name, description, sequenceType), and relationships (ruleset). Required: sequence_id.

list_all_outreach_snippets

List Outreach snippets. Returns each snippet with id, type, attributes (bodyHtml, name), and relationships (owner).

get_single_outreach_snippet_by_id

Get a single Outreach snippet by id. Returns id, type, attributes (bodyHtml, name), and relationships (owner). Required: id.

create_a_outreach_snippet

Create a new Outreach snippet. Returns the created snippet with id, type, attributes (bodyHtml, name), and relationships (owner). Required: data.type.

update_a_outreach_snippet_by_id

Update an Outreach snippet by id. Returns the updated snippet with id, type, attributes (bodyHtml, name), and relationships (owner). Required: id, data.type, data.id.

delete_a_outreach_snippet_by_id

Delete an Outreach snippet by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_stages

List a collection of stages in Outreach. Returns: attributes, id, relationships, type.

get_single_outreach_stage_by_id

Get a single Outreach stage by id. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_stage

Create a new stage in Outreach. Returns the created stage with type, id, attributes (name, order), and relationships. Required: data.type.

update_a_outreach_stage_by_id

Update an existing Outreach stage by id. Returns: attributes, id, relationships, type. Required: id, data.type, data.id.

delete_a_outreach_stage_by_id

Delete an Outreach stage by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_task_dispositions

List task dispositions in Outreach. Returns each record with type, id, attributes, and relationships.

get_single_outreach_task_disposition_by_id

Get a single task disposition by id in Outreach. Returns the record including type, id, attributes, and relationships. Required: id.

create_a_outreach_task_disposition

Create a new task disposition in Outreach. Returns the created record including type, id, attributes, and relationships. Required: data.

update_a_outreach_task_disposition_by_id

Update an existing task disposition in Outreach. Returns the updated record including type, id, attributes, and relationships. Required: id, data (with type and id).

delete_a_outreach_task_disposition_by_id

Delete a task disposition by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_task_priorities

List task priorities in Outreach. Returns a collection of JSON API resource objects, each containing type, id, attributes, and relationships. Up to 50 records per page.

get_single_outreach_task_priority_by_id

Get a single task priority in Outreach by id. Returns the task priority resource object including its type, id, attributes, and relationships. Required: id.

list_all_outreach_task_purposes

List a collection of task purposes in Outreach. Returns each task purpose with id, type, attributes, and relationships.

get_single_outreach_task_purpose_by_id

Get a single task purpose by id in Outreach. Returns: attributes, id, relationships, type. Required: id.

create_a_outreach_task_purpose

Create a new task purpose in Outreach. Returns the created task purpose with id, type, attributes, and relationships.

update_a_outreach_task_purpose_by_id

Update an existing task purpose by id in Outreach. Returns the updated task purpose with id, type, attributes, and relationships. Required: id, data.type, data.id.

delete_a_outreach_task_purpose_by_id

Delete an existing task purpose by id in Outreach. Returns an empty 204 response on success. Required: id.

list_all_outreach_teams

List a collection of Outreach teams. Returns each team record including type, id, attributes, and relationships.

get_single_outreach_team_by_id

Get a single Outreach team by id. Returns the team object including type, id, attributes, and relationships. Required: id.

create_a_outreach_team

Create a new team in Outreach. Returns the created team object including type, id, attributes, and relationships. Required: data (with type).

update_a_outreach_team_by_id

Update an existing Outreach team by id. Returns the updated team object including type, id, attributes, and relationships. Required: id, data (with type and id).

delete_a_outreach_team_by_id

Delete an existing Outreach team by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_templates

List Outreach email templates. Returns a collection of template objects, each with id, type, attributes (bodyHtml, subject, name, ccRecipients), and relationships (owner, mailings, sequenceTemplates, tasks).

get_single_outreach_template_by_id

Get a single Outreach email template by id. Returns the template object including id, type, attributes (bodyHtml, subject, name, ccRecipients), and relationships (owner, mailings, sequenceTemplates, tasks). Required: id.

create_a_outreach_template

Create a new Outreach email template. Returns the created template object including id, type, attributes (bodyHtml, subject, name, ccRecipients), and relationships (owner, mailings, sequenceTemplates, tasks). Required: data.

update_a_outreach_template_by_id

Update an existing Outreach email template by id. Returns the updated template object including id, type, attributes (bodyHtml, subject, name, ccRecipients), and relationships (owner, mailings, sequenceTemplates, tasks). Required: id, data, data.type, data.id.

delete_a_outreach_template_by_id

Delete an Outreach email template by id. Returns an empty 204 response on success. Required: id.

list_all_outreach_webhooks

List Outreach webhooks. Returns each webhook with id, type, and attributes including action, active, url, resource, payloadVersion, secret, cleanupToken, createdAt, and updatedAt.

create_a_outreach_webhook

Create a new webhook in Outreach to receive event notifications at an HTTPS URL. Returns the created webhook with id, type, and attributes including action, active, url, resource, payloadVersion, secret, cleanupToken, creatorAppId, creatorAppName, createdAt, and updatedAt. Required: data (with type and attributes.url).

get_single_outreach_webhook_by_id

Get a single Outreach webhook by id. Returns the webhook with id, type, and attributes including action, active, url, resource, payloadVersion, secret, cleanupToken, createdAt, and updatedAt. Required: id.

update_a_outreach_webhook_by_id

Update an existing Outreach webhook by id. Returns the updated webhook with id, type, and attributes including action, active, url, resource, payloadVersion, secret, cleanupToken, createdAt, and updatedAt. Required: id, data (with type and id).

delete_a_outreach_webhook_by_id

Delete an Outreach webhook by id. Returns an empty 204 response on success. Required: id.