Engage Bay — Sushidata avatar

Engage Bay — Sushidata

Pricing

Pay per usage

Go to Apify Store
Engage Bay — Sushidata

Engage Bay — Sushidata

Pricing

Pay per usage

Rating

0.0

(0)

Developer

Sushidata

Sushidata

Maintained by Community

Actor stats

0

Bookmarked

3

Total users

3

Monthly active users

4 months ago

Last modified

Share

EngageBay CRM API Actor

Interact with the full EngageBay REST API from the Apify platform. This Actor supports 75 operations across all EngageBay resources: Contacts, Companies, Deals, Tracks, Events, Tasks, Notes, Forms, Sequences, Lists, Owners, Custom Fields, Tickets, Tags, Products, and Broadcasts.

Authentication

Find your REST API Key in EngageBay → Account Admin Settings → API → REST API Key and pass it as apiKey.

The apiKey input is marked as secret and will not appear in logs.

Input

FieldTypeRequiredDescription
apiKeystring✅EngageBay REST API Key
actionstring✅Operation to perform (see full list below)
contactIdstringContact ID (for contact-specific operations)
companyIdstringCompany ID
dealIdstringDeal ID
trackIdstringTrack ID
taskIdstringTask ID
ticketIdstringTicket ID
productIdstringProduct ID
formIdstringForm ID
sequenceIdstringSequence ID
listIdstringContact List ID
customFieldTypestringCONTACT / DEAL / COMPANY / TICKET
customFieldIdstringCustom Field ID (for delete)
emailstringContact email address (for email-based operations)
ownerEmailstringNew owner email (for contacts_change_owner)
searchQuerystringKeyword for search operations
startTimeintegerEpoch ms — required for events_list
endTimeintegerEpoch ms — required for events_list
pageSizeintegerRecords per page (1–100, default 20)
sortKeystringcreated_time, updated_time, or prepend - for descending
cursorstringPagination cursor to resume from
fetchAllbooleanAuto-paginate all pages (default false)
dataobjectRequest body / action-specific filters (see per-action examples)

Supported Actions

Contacts

ActionRequired fieldsdata shape
contacts_list——
contacts_getcontactId—
contacts_get_by_emailemail—
contacts_create—Contact JSON
contacts_update—{id, properties:[...]}
contacts_deletecontactId—
contacts_searchsearchQuery—
contacts_add_tagsemail{tags: ["tag1","tag2"]}
contacts_delete_tagsemail{tags: ["tag1"]}
contacts_list_tagsemail—
contacts_list_tags_by_idcontactId—
contacts_add_tags_by_idcontactId{tags: [{tag:"tag1"}]}
contacts_delete_tags_by_idcontactId{tags: [{tag:"tag1"}]}
contacts_add_scoreemail{score: 10}
contacts_change_ownercontactId, ownerEmail—
contacts_create_batch—{contacts:[...], callbackURL:"..."}
contacts_get_notescontactId—
contacts_get_call_logscontactId—

Companies

ActionRequired fieldsdata shape
companies_list——
companies_getcompanyId—
companies_create—Company JSON
companies_update—{id, properties:[...]}
companies_deletecompanyId—
companies_searchsearchQuery—
companies_add_contact_by_idcompanyId, contactId—
companies_add_contact_by_emailcompanyId, email—

Deals

ActionRequired fieldsdata shape
deals_list—{trackId: "..."} (optional)
deals_getdealId—
deals_create—{name, amount, track_name, milestoneLabelName}
deals_deletedealId—
deals_create_for_contactemail{name, amount, track_name, milestoneLabelName}
deals_searchsearchQuery—
deals_update_track—{id, milestoneLabelName, track_id}
deals_update—{id, properties:[...]}

Tracks

ActionRequired fields
tracks_list—
tracks_gettrackId
tracks_createdata: {name, milestones:[...]}
tracks_updatedata: {id, name, milestones:[...]}
tracks_deletetrackId

Events

ActionRequired fields
events_liststartTime, endTime (epoch ms)
events_get_for_contactcontactId
events_createdata: {name, start_time, end_time, source_type, owner_id}
events_updatedata: {id, name, start_time, end_time, source_type, owner_id}

Tasks

ActionRequired fieldsdata shape
tasks_list—{taskStatus: "not_started", taskType: "ALL"}
tasks_gettaskId—
tasks_create—Task JSON
tasks_update—Task JSON with id
tasks_deletetaskId—

taskStatus values: not_started, in_progress, waiting, completed, deferred
taskType values: TODO, EMAIL, CALL, ALL

Notes

Actiondata shape
notes_create{subject, content, parentId}

Forms

ActionRequired fields
forms_list—
forms_add_contactemail, formId

Sequences

ActionRequired fields
sequences_add_contactemail, sequenceId

Lists

ActionRequired fields
lists_list—
lists_add_contactemail, listId

Owners

ActionRequired fields
owners_list—

Custom Fields

ActionRequired fieldsdata shape
custom_fields_listcustomFieldType—
custom_fields_create—{field_label, scope, field_description, field_type, is_required, is_searchable}
custom_fields_deletecustomFieldType, customFieldId—

User Profile

ActionRequired fields
user_profile—

Tickets

ActionRequired fieldsdata shape
tickets_list—{filterId: "..."} (optional)
tickets_getticketId—
tickets_create—{requester_name, requester_email, subject, group_id, html_body}
tickets_deleteticketId—

Tags

Actiondata shape
tags_list—
tags_create{tag: "MyTag"}

Products

ActionRequired fieldsdata shape
products_list——
products_getproductId—
products_get_by_name—{productName: "My Product"}
products_create—{name, description, price, discount_type, discount, currency}
products_updateproductIdFull product JSON
products_update_partial—{id, price, name, properties:[...]}
products_deleteproductId—
products_add_to_contactcontactId{productId, isSubscribed, subscribedOn, interval}
products_remove_from_contactcontactId, productId—

Broadcast

Actiondata shape
broadcast_create{emailIds: [...], template_id: 12345, from_email: "from@domain.com"}

Pagination

For list operations, the actor fetches one page by default (pageSize records, max 100). Set fetchAll: true to automatically paginate through all pages. Use cursor to start from a specific page.

Output

Results are pushed to the Apify dataset. Each record is a JSON object returned by the EngageBay API.

Error Handling

HTTP StatusMeaning
400Bad request — check your data payload
401Invalid API key
404Resource not found
429Rate limit exceeded

EngageBay REST API Reference

Full API documentation: https://github.com/engagebay/restapi