Skip to content
Changelog

Report a bug

Benchmark Email integration: operations for AI agents

Benchmark Email connects to Type.com as an integration. This page lists the 42 operations documented for Claude and Codex in Type.com: 25 read, 9 write, 8 destructive.

About Benchmark Email

Benchmark Email vendor API references, subject to account permissions.

Categories: Marketing & Social

How to connect Benchmark Email to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

42 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

42 operations listed.

account

  • Read

    Get account information

    Get account information

    GET /api/account

contact

  • Read

    Get all contacts

    Get all contacts

    GET /api/contact

  • Read

    Get account contact events

    Get all contact events for the account

    GET /api/contact/events

  • Read

    Export contacts

    Exports contacts under contacts:read scope. The captured formal source does not specify a job lifecycle; no asynchronous creation or deletion is invented.

    POST /api/contact/export

  • Read

    Search for contacts

    Queries contacts using documented filters; POST is semantic read.

    POST /api/contact/search

  • Read

    Get a contact by id

    Get a contact by id

    GET /api/contact/{contactId}

  • Read

    Get contact events

    Get events for a contact

    GET /api/contact/{contactId}/events

  • Write

    Create a new contact

    Create a new contact

    POST /api/contact

  • Destructive

    Delete a contact by id

    Delete a contact by id

    DELETE /api/contact/{contactId}

  • Destructive

    Partial update a contact by id

    Conditional: status=Inactive/secondary=Unsubscribe inactivates the contact. Once inactive it cannot be reactivated through the API; renewed opt-in must use the signup flow.

    PATCH /api/contact/{contactId}

  • Destructive

    Update a contact by id

    Replaces the entire contact: omitted fields are removed. Fetch the full contact, modify it and send the complete data; __v optimistic-concurrency behavior is documented.

    PUT /api/contact/{contactId}

  • Destructive

    Apply a delta mutation to a contact.

    Delta mutation for one existing contact. Accepts any combination of `addTags`, `removeTags`, `addLists`, `removeLists`, and `updateFields`; omitted operations leave the corresponding facet unchanged. Status changes are handled by `PATCH /api/contact/:contactId`, not this endpoint. Operations are atomic — all-or-nothing in a single save. Idempotent: adding a tag already present, removing a tag not present, or setting a field to its current value is a no-op and is rejected with 400 only when *every* operation in the request resolves to no change. `__v` is optional: when supplied, optimistic-concurrency control is enforced (stale version → 400 ConcurrencyError); when omitted, the request runs last-write-wins.

    PUT /api/contact/{contactId}/mutate

contact-structure

  • Read

    Get all contact structures

    Get all contact structures

    GET /api/contact-structure

  • Read

    Get a contact structure by id

    Get a contact structure by id

    GET /api/contact-structure/{contactStructureId}

  • Write

    Create a new contact structure

    Create a new contact structure

    POST /api/contact-structure

  • Destructive

    Update a contact structure by id

    Replaces the full contact structure: omitted fields are removed. Include all desired fields and current __v. Removing fields used by published signup forms is rejected with affected-form details.

    PUT /api/contact-structure/{contactStructureId}

lists

  • Read

    Get paginated lists

    Get paginated lists

    GET /api/contact-structure/{contactStructureId}/lists

  • Read

    Get all lists

    Get all lists

    GET /api/contact-structure/{contactStructureId}/lists/all

  • Read

    Get a list by id

    Get a list by id

    GET /api/contact-structure/{contactStructureId}/lists/{listId}

  • Write

    Create a new list

    Create a new list

    POST /api/contact-structure/{contactStructureId}/lists

  • Write

    Merge lists into a new list.

    Creates a new list with unique contacts from source lists; source lists remain intact. This merge is not a deletion of its source lists.

    POST /api/contact-structure/{contactStructureId}/lists/merge

  • Write

    Update a list by id

    Update a list by id

    PATCH /api/contact-structure/{contactStructureId}/lists/{listId}

  • Write

    Duplicate a list

    Duplicate a list

    POST /api/contact-structure/{contactStructureId}/lists/{listId}/duplicate

  • Destructive

    Delete multiple lists

    Delete multiple lists

    DELETE /api/contact-structure/{contactStructureId}/lists

  • Destructive

    Delete a list by id

    Delete a list by id

    DELETE /api/contact-structure/{contactStructureId}/lists/{listId}

email-campaign

  • Read

    Get all campaigns

    Get all campaigns

    GET /api/email/campaign

  • Read

    Get campaign by id

    Get campaign by id

    GET /api/email/campaign/{campaignId}

  • Write

    Add a campaign

    Add a campaign

    POST /api/email/campaign

  • Write

    Update campaign by id

    Update campaign by id

    PATCH /api/email/campaign/{campaignId}

  • Write

    Duplicate an existing campaign

    Duplicate an existing campaign

    POST /api/email/campaign/{campaignId}/duplicate

  • Destructive

    Delete campaign by id

    Delete campaign by id

    DELETE /api/email/campaign/{campaignId}

email-domain

  • Read

    Get all domains

    Get all domains

    GET /api/email/domain

  • Read

    Get the grey label domain for the account

    Get the grey label domain for the account

    GET /api/email/domain/grey-label

  • Read

    Get a domain by id

    Get a domain by id

    GET /api/email/domain/{domainId}

email-template

  • Read

    Get email templates

    Get email templates with optional filters

    GET /api/email/template

  • Read

    Get email template categories

    Get all email template categories

    GET /api/email/template/categories

  • Read

    Get email template by ID

    Get an email template by its ID

    GET /api/email/template/{id}

reports

  • Read

    Get dashboard snapshot reports

    Get dashboard snapshot reports

    GET /api/reports/dashboard

  • Read

    Get overall email reports

    Get overall email reports

    GET /api/reports/email/overall

  • Read

    Get overall email histogram by event type

    Get overall email histogram by event type

    GET /api/reports/email/overall/histogram

  • Read

    Get individual email campaign reports

    Get individual email campaign reports

    GET /api/reports/email/{id}

  • Read

    Get individual email campaign engagement reports

    Get individual email campaign engagement reports

    GET /api/reports/email/{id}/engagement

See How connections work for access and permissions, or browse all integrations.