Skip to main content
Server path: /customerio-admin | Type: Application | PCID required: Yes

Tools

ToolDescription
customerio_admin_create_webhookCreate a reporting webhook
customerio_admin_delete_suppressionUn-suppress an ESP-suppressed address
customerio_admin_delete_webhookDelete a reporting webhook
customerio_admin_download_exportDownload an export
customerio_admin_export_deliveries_dataExport information about deliveries
customerio_admin_export_people_dataExport customer data
customerio_admin_get_cio_allowlistList IP addresses
customerio_admin_get_domain_suppressions_by_typeGet ESP-suppressed emails by domain
customerio_admin_get_exportGet an export
customerio_admin_get_importRetrieve a bulk import
customerio_admin_get_senderGet a sender
customerio_admin_get_sender_usageGet sender usage data
customerio_admin_get_suppressionLook up an ESP-suppressed address
customerio_admin_get_suppression_by_typeGet ESP-suppressed emails by type
customerio_admin_get_webhookGet a reporting webhook
customerio_admin_importImport items in bulk
customerio_admin_list_activitiesList activities
customerio_admin_list_exportsList exports
customerio_admin_list_sendersList sender identities
customerio_admin_list_webhooksList reporting webhooks
customerio_admin_list_workspacesList workspaces
customerio_admin_post_suppressionSuppress an email at the ESP
customerio_admin_update_attribute_metadataAdd or update attributes
customerio_admin_update_event_metadataAdd or update events
customerio_admin_update_webhookUpdate a webhook configuration

customerio_admin_create_webhook

Create a reporting webhook Parameters:
ParameterTypeRequiredDefaultDescription
disabledbooleanNoSet to true to quit sending events to the webhook URL. Set to false to enable the webhook.
endpointstringYesThe webhook URL.
eventsstring[]YesSpecifies the types of events you want to report to your webhook. See our reporting webhooks reference for more information about event types and the information they return.
full_resolutionbooleanNoSet to false to send unique open and click events to the webhook. Set to true to send all events.
idintegerNoThe identifier for the webhook.
namestringYesThe name of your webhook.
with_contentbooleanNoSet to true to include the message body in _sent events.

customerio_admin_delete_suppression

Un-suppress an ESP-suppressed address Parameters:
ParameterTypeRequiredDefaultDescription
suppression_typestringYesThe reason a person’s email address was suppressed by the email service provider (ESP).
email_addressstringYesThe email address of the person you want to look up.

customerio_admin_delete_webhook

Delete a reporting webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idintegerYesThe identifier of a webhook.

customerio_admin_download_export

Download an export Parameters:
ParameterTypeRequiredDefaultDescription
export_idintegerYesThe export_id you want to access.

customerio_admin_export_deliveries_data

Export information about deliveries Parameters:
ParameterTypeRequiredDefaultDescription
bodyobjectNoRequest body

customerio_admin_export_people_data

Export customer data Parameters:
ParameterTypeRequiredDefaultDescription
filtersobjectYesWhen filtering for people, you can use and and or arrays to determine the logic for a group of filter conditions. not reverses the filter condition and matches when the condition is false. segment and attribute represent the individual conditions you can filter a group of people for. The top level of this object can only contain a single property, but you can nest and and or properties to produce complex filters.

customerio_admin_get_cio_allowlist

List IP addresses

customerio_admin_get_domain_suppressions_by_type

Get ESP-suppressed emails by domain Parameters:
ParameterTypeRequiredDefaultDescription
domain_namestringYesThe sending domain you want to look up suppressions for.
suppression_typestringYesThe reason a person’s email address was suppressed by the email service provider (ESP).
limitintegerNoThe maximum number of results you want to retrieve per page.
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
emailstringNoFilter results to a specific email address. When provided, returns at most one result and cursor-based pagination does not apply.

customerio_admin_get_export

Get an export Parameters:
ParameterTypeRequiredDefaultDescription
export_idintegerYesThe export_id you want to access.

customerio_admin_get_import

Retrieve a bulk import Parameters:
ParameterTypeRequiredDefaultDescription
import_idintegerYesThe id of the import you want to lookup. This value is returned from an import that was accepted and queued for processing.

customerio_admin_get_sender

Get a sender Parameters:
ParameterTypeRequiredDefaultDescription
sender_idintegerYesThe identifier of a sender.

customerio_admin_get_sender_usage

Get sender usage data Parameters:
ParameterTypeRequiredDefaultDescription
sender_idintegerYesThe identifier of a sender.

customerio_admin_get_suppression

Look up an ESP-suppressed address Parameters:
ParameterTypeRequiredDefaultDescription
email_addressstringYesThe email address of the person you want to look up.

customerio_admin_get_suppression_by_type

Get ESP-suppressed emails by type Parameters:
ParameterTypeRequiredDefaultDescription
suppression_typestringYesThe reason a person’s email address was suppressed by the email service provider (ESP).
limitintegerNoThe maximum number of results you want to retrieve per page.
offsetintegerNoThe number of records to skip before retrieving results.
domainstringNoFilter by sending domain.

customerio_admin_get_webhook

Get a reporting webhook Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idintegerYesThe identifier of a webhook.

customerio_admin_import

Import items in bulk Parameters:
ParameterTypeRequiredDefaultDescription
importobjectYesThe import value

customerio_admin_list_activities

List activities Parameters:
ParameterTypeRequiredDefaultDescription
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
typestringNoThe type of activity you want to search for. Types with _o:<object_type_id> are for objects and types with _r:<object_type_id> are for relationships.
namestringNoThe name of the event or attribute you want to return.
deletedbooleanNoIf true, return results for deleted people.
customer_idstringNoThe identifier of the person you want to look up. By default, this is a person’s id. You can use the id_type parameter to look up a person by email or cio_id. If you use a person’s cio_id, you must prefix the value value with cio_ when using it to find or reference a person (i.e. cio_03000010 for a cio_id value of 03000010).
id_typestringNoThe type of customer_id you want to use to reference a person. If you don’t provide this parameter, we assume that the customer_id in your request is a person’s id.
limitintegerNoThe maximum number of results you want to retrieve per page.

customerio_admin_list_exports

List exports

customerio_admin_list_senders

List sender identities Parameters:
ParameterTypeRequiredDefaultDescription
startstringNoThe token for the page of results you want to return. Responses contain a next property. Use this property as the start value to return the next page of results.
limitintegerNoThe maximum number of results you want to retrieve per page.
sortstringNoDetermine how you want to sort results, asc for chronological order and desc for reverse chronological order.

customerio_admin_list_webhooks

List reporting webhooks

customerio_admin_list_workspaces

List workspaces

customerio_admin_post_suppression

Suppress an email at the ESP Parameters:
ParameterTypeRequiredDefaultDescription
suppression_typestringYesThe reason a person’s email address was suppressed by the email service provider (ESP).
email_addressstringYesThe email address of the person you want to look up.

customerio_admin_update_attribute_metadata

Add or update attributes Parameters:
ParameterTypeRequiredDefaultDescription
attributesobject[]YesArray of attribute updates

customerio_admin_update_event_metadata

Add or update events Parameters:
ParameterTypeRequiredDefaultDescription
eventsobject[]YesArray of event updates

customerio_admin_update_webhook

Update a webhook configuration Parameters:
ParameterTypeRequiredDefaultDescription
webhook_idintegerYesThe identifier of a webhook.
disabledbooleanNoSet to true to quit sending events to the webhook URL. Set to false to enable the webhook.
endpointstringNoThe webhook URL.
eventsstring[]NoSpecifies the types of events you want to report to your webhook. See our reporting webhooks reference for more information about event types and the information they return.
full_resolutionbooleanNoSet to false to send unique open and click events to the webhook. Set to true to send all events.
idintegerNoThe identifier for the webhook.
namestringNoThe name of your webhook.
with_contentbooleanNoSet to true to include the message body in _sent events.