Search
Introduction
Authentication
Manage API keys
SDKs
Javascript SDK
PHP SDK
Using filter with collections
Security
JWT session
post
Delete user session
post
Create a session with email and password
API keys
get
Retrieve API keys
post
Create an API key
get
Retrieve API key
put
Upsert an API key
del
Delete API key
Reset password
post
Request a password reset
Email
Broadcast messages
get
Retrieve broadcast messages
post
Create a broadcast message
get
Retrieve a broadcast message
del
Delete a broadcast message
patch
Update a broadcast message
Email delivery settings
put
Verify an email delivery setting
get
Retrieve email delivery settings
post
Create an email delivery setting
get
Retrieve an email delivery setting
del
Delete an email delivery setting
patch
Update an email delivery setting
post
Resend email delivery setting verification email
Email messages
get
Retrieve email messages
post
Create an email message
get
Retrieve an email message
del
Delete an email message
patch
Send an email message
Rules
Rules
get
Retrieve system events
get
Retrieve event information
get
Retrieve event rules
put
Update event rules
get
Retrieve change history of a ruleset
get
Retrieve change history record of a ruleset
get
Retrieve a version of a ruleset
get
Retrieve draft rulesets
post
Create a draft ruleset
get
Retrieve a draft ruleset
del
Delete a draft ruleset
put
Update a draft ruleset
post
Send a test email
post
Trigger a test webhook
Lists
get
Retrieve lists
post
Create a list
get
Retrieve latest list version
put
Upsert a list
del
Delete a list
get
Retrieve specific list version
Email notifications
get
Retrieve email notification events
get
Retrieve email notification attributions
Rules timeline
get
Retrieve rules engine timeline messages
post
Create a rules engine timeline comment
get
Retrieve a rules engine timeline message
del
Delete a rules engine timeline message
Users
Profile
post
Activate user
post
Start permissions emulation
del
Stop permissions emulation
get
Retrieve user's own profile
put
Update a user profile
get
Retrieve user MFA status
post
Update user MFA
del
Delete user MFA
post
Register and create new profile
Users
get
Retrieve a list of users
post
Create a user
get
Retrieve a user
put
Upsert a user
get
Retrieve user MFA status
Memberships
get
Retrieve memberships
get
Retrieve a membership
put
Upsert membership
del
Delete a membership
Roles
get
Retrieve roles
post
Create a role
get
Retrieve a role
put
Create a role with ID
del
Delete a role
Organization data exports
get
Retrieve organization data exports
post
Request an organization data export
get
Retrieve an organization data export request
Applications
Application owners
post
Register an application
get
Retrieve application instances
get
Retrieve an application instance
Event
Application instance was disabled
Event
Application instance was enabled
Application users
get
Retrieve an application instance
put
Upsert an application instance
del
Delete application instance
get
Retrieve an application instance configuration
put
Upsert an application instance configuration
get
Retrieve applications
get
Retrieve application
Webhooks
Webhooks
post
Trigger a test webhook
get
Retrieve webhooks
post
Create a webhook
get
Retrieve a webhook
put
Upsert a webhook
Other
Balance transactions
get
Retrieve balance transactions
get
Retrieve a balance transaction
Event
Balance transaction settled
Billing portals
get
Retrieve billing portals
post
Create a billing portal
get
Retrieve a billing portal
put
Upsert a billing portal
del
Delete a billing portal
Checkout forms
get
Retrieve checkout forms
post
Create a checkout form
get
Retrieve a checkout form
put
Upsert a checkout form
del
Delete a checkout form
Gateway accounts
get
Retrieve gateway accounts
post
Create a gateway account
get
Retrieves a gateway account
put
Upsert a gateway account
patch
Update a gateway account
del
Delete a gateway account
post
Close a gateway account
post
Disable a gateway account
get
List gateway account downtime schedules
post
Create a gateway account downtime schedule
get
Retrieve a gateway account downtime schedule
put
Update a gateway account downtime schedule
del
Delete a gateway account downtime schedule
post
Enable a gateway account
get
Retrieve gateway account limits
get
Retrieve a gateway account limit
put
Update a gateway account limit
del
Delete a gateway account limit
post
Verify gateway account credentials
get
Retrieve financial settings of a gateway account
put
Set financial settings
post
Register a domain for Apple Pay
Event
Gateway account downtime ended
Event
Gateway account downtime started
Event
Gateway account limit reached
Gateway accounts timeline
get
Retrieve gateway account timeline messages
post
Create a gateway account timeline comment
get
Retrieve a gateway timeline message
del
Delete a gateway timeline message
Payment instruments
get
Retrieve payment card issuing bank names
Organizations
get
Retrieve organizations
post
Create an organization
get
Retrieve an organization
patch
Update an organization
Segments
get
Retrieve a user's segments
post
Create a new UI segment
get
Retrieve a segment
put
Update a segment
del
Delete a segment
Status
get
Retrieve API current status
Tracking
get
Retrieve API tracking logs
get
Retrieve an API tracking log
get
Retrieve tax service tracking logs
get
Retrieve a tax service tracking log
get
Retrieve value list changes
get
Retrieve webhook tracking logs
get
Retrieve a webhook tracking log
post
Schedule a resend webhook attempt
Websites
get
Retrieve websites
post
Create a website
get
Retrieve a website
put
Upsert a website
del
Delete a website
Custom domains
get
Retrieve custom domains
post
Create a custom domain
get
Retrieve a custom domain
del
Delete a custom domain
Integrations
get
Retrieve integrations
get
Retrieve an integration for specific label
Service credentials
get
Retrieve service credentials
post
Create a service credential
get
Retrieve a service credential
patch
Update a service credential
get
List credential root items
External identifiers
get
Retrieve external identifiers
get
Retrieve an external identifier
post
Sync an external identifier
put
Upsert an external identifier
del
Delete an external identifier
get
Retrieve external service settings
put
Update external service settings
Metadata
get
Retrieve payment method metadata
get
Retrieve metadata of a payment method
get
Retrieve payment gateway metadata
get
Retrieve payment gateway metadata
Service credentials
Use these operations to get, create, and manage credentials for third-party services.
➔ Next to
Service credentials / Retrieve service credentials