Pocketflows home pagelight logodark logo
  • Support
  • Dashboard
  • Dashboard
The Employee object
Base
Email and SMS
Loyalty
API Documentation
  • Introduction
  • Idempotency Keys
  • Errors
Businesses
  • The Business object
  • GET
    List all businesses
  • POST
    Create a business
  • GET
    Retrieve a business
  • POST
    Update a business
  • DEL
    Delete a business
  • GET
    Retrieve the segment usage for a business
Customers
  • The Customer object
  • GET
    List all customers for a business
  • POST
    Create a customer
  • GET
    Retrieve a customer
  • POST
    Update a customer
  • POST
    Unsubscribe a customer from campaigns and triggers
  • POST
    Resubscribe a customer to campaigns and triggers
  • DEL
    Delete a customer
  • POST
    Create multiple customers
  • POST
    Update multiple customers
Sync
  • Overview
  • POST
    Sync a business
  • POST
    Sync a batch of businesses
  • POST
    Sync a customer
  • POST
    Sync a batch of customers
Segments
  • The Segment object
  • GET
    List all the business's segments
  • POST
    Create a segment
  • GET
    Retrieve a segment
  • POST
    Add a customer to a segment
  • DEL
    Remove a customer from a segment
  • DEL
    Delete a segment
Embeds
  • Overview
  • The Embed object
  • POST
    Create an embed
  • GET
    Fetch information about an embed
  • GET
    Render the user experience of the embed

The Employee object

The schema is of type object.

Powered by Mintlify
{
  "id": "<string>",
  "email_address": "<string>",
  "phone_number": "<string>"
}