דלג לתוכן הראשי
Reference indexShow

API reference

Customers & Documents

A customer is the person or business a call is with. Phone and email are stored encrypted. Customers are matched by phone in any format.

Find Customer

GET/api/make/customer/{teamId}

Finds a customer by Saleso customer ID, phone number, or email.

Used by:
Make: Get Customer · Zapier: Find Customer

Parameters

  • teamIdstringrequired

    Your Team ID.

  • customer_idstring· Query

    The Saleso customer ID. Or leave empty and search by Phone or Email.

  • phonestring· Query

    Full customer phone number in any format (050-1234567, 0501234567, +972501234567). If several customers share the number, the oldest is returned.

  • emailstring· Query

    Customer email address to search by.

Response

13 response fieldsShow
  • idstring

    Customer ID

  • namestring

    Name

  • phonestring

    Phone

  • emailstring

    Email

  • companystring

    Company

  • statusstring

    Status

  • notesstring

    Notes

  • call_countinteger

    Call Count

  • last_call_datedatetime

    Last Call Date

  • call_idsarray

    IDs of the customer’s calls, newest first.

  • created_atdatetime

    Created At

  • updated_atdatetime

    Updated At

  • profileobject

    Profile fields Saleso extracted from the customer’s calls, or null.

  • Lookup order: customer_id, then phone, then email. Unlike Find Lead, no match is a 404.

Errors

  • 400None of customer_id, phone, email was sent, or phone is not a full number (at least 9 digits).
  • 404Customer not found.
  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 500Unexpected server error. The error field carries the message.
Request
curl -X GET "https://try.saleso.io/api/make/customer/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY"
Response · 200
{
  "id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
  "name": "Dana Levi",
  "phone": "0501234567",
  "email": "dana@example.com",
  "company": "Levi Logistics",
  "status": "Interested",
  "notes": "Prefers WhatsApp.",
  "profile": {},
  "call_count": 4,
  "last_call_date": "2026-10-22T09:30:00.000Z",
  "call_ids": [
    "b263551b-19d2-42d6-b4dc-ca56ec59b769"
  ],
  "created_at": "2026-10-22T09:30:00.000Z",
  "updated_at": "2026-10-22T09:30:00.000Z"
}

List Customers

GET/api/make/customers/search/{teamId}

Gets customers that match a name, company, or status.

Used by:
Make: Search Customers · Zapier: List Customers

Parameters

  • teamIdstringrequired

    Your Team ID.

  • querystring· Query

    Optional. Matches name or company (contains, case-insensitive). Up to 100 characters.

  • statusstring· Query

    Filter by customer status.

  • limitinteger· Query

    Results per page, up to 100. Default 20.

    Default: 20

  • offsetinteger· Query

    How many customers to skip, for paging. Use 0 for the first page.

    Default: 0

  • include_piiboolean· Query

    Send true to include phone and email in each result. Without it they are null.

    Default: false

Response

12 response fieldsShow
  • customers[].idstring

    Customer ID

  • customers[].namestring

    Name

  • customers[].phonestring

    Phone

  • customers[].emailstring

    Email

  • customers[].companystring

    Company

  • customers[].statusstring

    Status

  • customers[].call_countinteger

    Call Count

  • customers[].created_atdatetime

    Created At

  • totalinteger

    Total

  • has_moreboolean

    Has More

  • customers[].notesstring

    Customer notes, or null.

  • customers[].updated_atdatetime

    Last update.

  • Sorted by name.

Errors

  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 500Unexpected server error. The error field carries the message.
Request
curl -X GET "https://try.saleso.io/api/make/customers/search/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY"
Response · 200
{
  "customers": [
    {
      "id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
      "name": "Dana Levi",
      "phone": "0501234567",
      "email": "dana@example.com",
      "company": "Levi Logistics",
      "status": "Interested",
      "call_count": 4,
      "created_at": "2026-10-22T09:30:00.000Z",
      "notes": "Prefers WhatsApp.",
      "updated_at": "2026-10-22T09:30:00.000Z"
    }
  ],
  "total": 1,
  "has_more": true
}

Create Customer

POST/api/make/customers/create/{teamId}

Creates a new customer in Saleso.

Used by:
Make: Create Customer · Zapier: Create Customer

Parameters

  • teamIdstringrequired

    Your Team ID.

  • namestring· Bodyrequired

    Customer name.

  • phonestring· Body

    Customer phone number.

  • emailstring· Body

    Customer email.

  • companystring· Body

    Company name.

  • statusstring· Body

    Initial customer status.

  • notesstring· Body

    Customer notes.

Response

2 response fieldsShow
  • successboolean

    Success

  • customer_idstring

    Customer ID

  • Fires the customer_created webhook event.

Errors

  • 400name is required.
  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 500Unexpected server error. The error field carries the message.
Request
curl -X POST "https://try.saleso.io/api/make/customers/create/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Dana Levi",
  "phone": "0501234567",
  "email": "dana@example.com",
  "company": "Levi Logistics",
  "status": "Interested",
  "notes": "Prefers WhatsApp."
}'
Response · 200
{
  "success": true,
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d"
}

Update Customer

PATCH/api/make/customer/{teamId}

Updates a customer's details in Saleso. Fields left empty are not changed.

Used by:
Make: Update Customer · Zapier: Update Customer

Parameters

  • teamIdstringrequired

    Your Team ID.

  • customer_idstring· Bodyrequired

    The Saleso customer UUID to update.

  • namestring· Body

    Updated customer name.

  • phonestring· Body

    Updated phone number.

  • emailstring· Body

    Updated email address.

  • companystring· Body

    Updated company name.

  • statusstring· Body

    Updated customer status.

  • notesstring· Body

    Updated customer notes.

Response

2 response fieldsShow
  • successboolean

    Success

  • customer_idstring

    Customer ID

  • Only the fields you send are changed. Sending an empty phone or email clears it.

Errors

  • 400customer_id is required or Invalid status value (empty or over 100 characters).
  • 404Customer not found.
  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 500Unexpected server error. The error field carries the message.
Request
curl -X PATCH "https://try.saleso.io/api/make/customer/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
  "name": "Dana Levi",
  "phone": "0501234567",
  "email": "dana@example.com",
  "company": "Levi Logistics",
  "status": "Interested",
  "notes": "Prefers WhatsApp."
}'
Response · 200
{
  "success": true,
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d"
}

Add Customer Document from URL

POST/api/make/customer-documents/{teamId}

Adds a document to a customer from a file link. Saleso downloads the file and stores it on the customer.

Used by:
Make: Upload Customer Document (URL) · Zapier: Add Customer Document from URL

Parameters

  • teamIdstringrequired

    Your Team ID.

  • document_urlstring· Bodyrequired

    Required. A public https link to the file. Google Docs, Sheets, Slides and Drawings links are exported automatically (PDF, XLSX or PPTX).

  • file_namestring· Body

    Optional. If omitted, inferred from the URL.

  • customer_idstring· Body

    Identify the customer by customer_id, customer_phone or customer_email (checked in that order). A phone or email with no customer creates one.

  • customer_phonestring· Body
  • customer_emailstring· Body

Response

4 response fieldsShow
  • successboolean

    Success

  • document_idstring

    Document ID

  • customer_idstring

    Customer ID

  • customer_createdboolean

    Customer Created

  • Accepted files: PDF, Word, Excel, PowerPoint, TXT, CSV, JPEG, PNG, WebP and GIF, up to 25 MB each. Each team has 5 GB of document storage.
  • Customer documents must be enabled for your team.

Errors

  • 400Customer not found (with a hint), Missing document_url, Invalid document URL: …, Failed to download document: <status>, File too large (max 25MB), Downloaded file is empty, File type not allowed.
  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 403Customer documents feature is disabled for this team.
  • 413Team storage quota exceeded.
  • 500Unexpected server error. The error field carries the message.
Request
curl -X POST "https://try.saleso.io/api/make/customer-documents/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "document_url": "https://example.com/files/contract.pdf",
  "file_name": "make_1761125400000.mp3",
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
  "customer_phone": "0501234567",
  "customer_email": "dana@example.com"
}'
Response · 200
{
  "success": true,
  "document_id": "4285776e-215b-466e-b13a-4bdbd699694d",
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
  "customer_created": true
}

Upload Customer Document

POST/api/make/customer-documents/{teamId}

Uploads a file as multipart/form-data and stores it on a customer.

Used by:
Make: Upload Customer Document (File) · Zapier: Upload Customer Document

Parameters

  • teamIdstringrequired

    Your Team ID.

  • filefile· Formrequired

    Map a file from an earlier step, e.g. a Gmail attachment or a Google Drive file.

  • file_namestring· Formrequired

    File name including the extension, e.g. contract.pdf. When mapping a downloaded file, map its file name here.

  • customer_idstring· Form

    Identify the customer by Customer ID, Customer Phone, or Customer Email (one is enough). If no customer has that phone or email, one is created.

  • customer_phonestring· Form
  • customer_emailstring· Form

Response

4 response fieldsShow
  • successboolean

    Success

  • document_idstring

    Document ID

  • customer_idstring

    Customer ID

  • customer_createdboolean

    Customer Created

  • Same endpoint as Add Customer Document from URL, sent as multipart/form-data with the file in the file part. Same file types and limits.

Errors

  • 400Missing "file" field in multipart body, Empty file, File too large (max 25MB), File type not allowed, Customer not found.
  • 401The API key is missing, wrong, or belongs to another team (Invalid API key).
  • 403Customer documents feature is disabled for this team.
  • 413Team storage quota exceeded.
  • 500Unexpected server error. The error field carries the message.
Request
curl -X POST "https://try.saleso.io/api/make/customer-documents/$SALESO_TEAM_ID" \
  -H "x-api-key: $SALESO_API_KEY" \
  -F "file=@contract.pdf" \
  -F "file_name=contract.pdf" \
  -F "customer_phone=0501234567"
Response · 200
{
  "success": true,
  "document_id": "4285776e-215b-466e-b13a-4bdbd699694d",
  "customer_id": "8b258f8b-4228-40fa-8d24-5b16428e686d",
  "customer_created": true
}