Pricing

Pay per usage

Go to Apify Store

Engage Bay — Sushidata

Try for free

Pricing

Pay per usage

Rating

0.0

(0)

Developer

Sushidata

Actor stats

Bookmarked

Total users

Monthly active users

18 days ago

Last modified

Categories

Automation

Other

Developer tools

API Key

apiKey

Required

Your EngageBay REST API Key. Find it in Account Admin Settings → API → REST API Key.

Type:string

Action

action

Required

The EngageBay API operation to perform.

Type:string

Options:

contacts_listcontacts_getcontacts_get_by_emailcontacts_createcontacts_updatecontacts_deletecontacts_searchcontacts_add_tagscontacts_delete_tagscontacts_list_tagscontacts_list_tags_by_idcontacts_add_tags_by_idcontacts_delete_tags_by_idcontacts_add_scorecontacts_change_ownercontacts_create_batchcontacts_get_notescontacts_get_call_logscompanies_listcompanies_getcompanies_createcompanies_updatecompanies_deletecompanies_searchcompanies_add_contact_by_idcompanies_add_contact_by_emaildeals_listdeals_getdeals_createdeals_deletedeals_create_for_contactdeals_searchdeals_update_trackdeals_updatetracks_listtracks_gettracks_createtracks_updatetracks_deleteevents_listevents_get_for_contactevents_createevents_updatetasks_listtasks_gettasks_createtasks_updatetasks_deletenotes_createforms_listforms_add_contactsequences_add_contactlists_listlists_add_contactowners_listcustom_fields_listcustom_fields_createcustom_fields_deleteuser_profiletickets_listtickets_gettickets_createtickets_deletetags_listtags_createproducts_listproducts_getproducts_get_by_nameproducts_createproducts_updateproducts_update_partialproducts_deleteproducts_add_to_contactproducts_remove_from_contactbroadcast_create

Contact ID

contactId

Optional

EngageBay Contact ID. Required for: contacts_get, contacts_delete, contacts_list_tags_by_id, contacts_add_tags_by_id, contacts_delete_tags_by_id, contacts_change_owner, contacts_get_notes, contacts_get_call_logs, companies_add_contact_by_id, events_get_for_contact, products_add_to_contact, products_remove_from_contact.

Type:string

Company ID

companyId

Optional

EngageBay Company ID. Required for: companies_get, companies_delete, companies_add_contact_by_id, companies_add_contact_by_email.

Type:string

Deal ID

dealId

Optional

EngageBay Deal ID. Required for: deals_get, deals_delete.

Type:string

Track ID

trackId

Optional

EngageBay Track ID. Required for: tracks_get, tracks_delete.

Type:string

Task ID

taskId

Optional

EngageBay Task ID. Required for: tasks_get, tasks_delete.

Type:string

Ticket ID

ticketId

Optional

EngageBay Ticket ID. Required for: tickets_get, tickets_delete.

Type:string

Product ID

productId

Optional

EngageBay Product ID. Required for: products_get, products_update, products_delete, products_remove_from_contact.

Type:string

Form ID

formId

Optional

EngageBay Form ID. Required for: forms_add_contact.

Type:string

Sequence ID

sequenceId

Optional

EngageBay Sequence ID. Required for: sequences_add_contact.

Type:string

List ID

listId

Optional

EngageBay Contact List ID. Required for: lists_add_contact.

Type:string

Custom Field Type

customFieldType

Optional

Scope for custom fields. Required for: custom_fields_list, custom_fields_delete.

Type:string

Options:

CONTACTDEALCOMPANYTICKET

Custom Field ID

customFieldId

Optional

EngageBay Custom Field ID. Required for: custom_fields_delete.

Type:string

Email Address

Optional

Contact email address. Required for email-based actions: contacts_get_by_email, contacts_add_tags, contacts_delete_tags, contacts_list_tags, contacts_add_score, contacts_change_owner, deals_create_for_contact, forms_add_contact, sequences_add_contact, lists_add_contact, companies_add_contact_by_email.

Type:string

Owner Email

ownerEmail

Optional

New owner's email address. Required for: contacts_change_owner.

Type:string

Search Query

searchQuery

Optional

Keyword to search for. Required for: contacts_search, companies_search, deals_search.

Type:string

Start Time (epoch ms)

startTime

Optional

Start time as epoch milliseconds. Required for: events_list.

Type:integer

End Time (epoch ms)

endTime

Optional

End time as epoch milliseconds. Required for: events_list.

Type:integer

Page Size

pageSize

Optional

Number of records to fetch per page for list operations (max 100).

Type:integer

Minimum:1

Maximum:100

Default:20

Sort Key

sortKey

Optional

Sort order for list operations. Use 'created_time' or 'updated_time' for ascending, prepend '-' for descending (e.g. '-created_time').

Type:string

Cursor

cursor

Optional

Pagination cursor to start from a specific page. Leave empty to start from the beginning.

Type:string

Fetch All Pages

fetchAll

Optional

If true, automatically paginate through all pages and return all results. If false, only fetch one page (up to pageSize records).

Type:boolean

Default:false

Request Body / Data

data

Optional

JSON object for create/update operations. Also used for action-specific filters (e.g. tasks_list accepts {taskStatus, taskType}; deals_list accepts {trackId}; tickets_list accepts {filterId}). See the README for per-action examples.

Type:object

Default: