canonical: https://jentic.com/apis/apideck.com/apideck-customer-support # Apideck Customer Support Apideck Customer Support is a unified API that maps a single customer schema onto downstream support platforms such as Zendesk, Freshdesk, Intercom, and HubSpot Service Hub. The 9.5.0 spec is intentionally narrow: 5 operations focused on the customer object, so a SaaS app can pull or push customer records through one integration regardless of which help desk the end user runs. Apideck routes each call through Apideck Vault so per-customer help-desk credentials never reach the calling app. ## For AI agents Read and write customer records across Zendesk, Freshdesk, Intercom, and other support platforms through one unified schema. ## Scope Does not handle tickets, conversations, knowledge base articles, or chat messages - use for customer record sync against support platforms only. ## Capabilities - List customer records on the connected support platform with pagination and filtering - Read a single customer by id with the unified contact, address, and metadata fields - Create a new customer in the connected support platform from an external sign-up flow - Update existing customer records when contact details change in the source app - Delete a customer record when the consumer is offboarded ## Use cases ### Sign-Up to Help-Desk Sync When a user signs up in a SaaS app, create the matching customer in whichever help desk the SaaS company runs - Zendesk, Freshdesk, Intercom, or HubSpot Service Hub - using a single integration. /customer-support/customers accepts the unified payload (name, email, phone, company) and Apideck translates it into the native customer record on the connected platform. Example prompt: POST /customer-support/customers with the new user's name and email when they complete sign-up so support agents see them immediately ### Profile Update Propagation Keep customer contact details consistent across the SaaS app and the help desk. When a user changes their email or phone in the app, PATCH /customer-support/customers/{id} so the support team sees the new information without a manual update. The unified schema means the same call works on every supported help desk. Example prompt: PATCH /customer-support/customers/{id} with the updated phone number whenever the user updates their profile in the source app ### GDPR Right-to-Erasure Delete customer records from the support platform when a user invokes their right to erasure. /customer-support/customers/{id} DELETE removes the record from whichever help desk is connected, so the SaaS app can fulfill a deletion request without per-platform deletion logic. Example prompt: DELETE /customer-support/customers/{id} as part of the user-deletion workflow and confirm the response status ### AI Agent Support Onboarding Give an AI agent a tool to provision and manage customer records in the customer's help desk. Through Jentic, the agent searches for an intent like 'create support customer' and gets the matching Apideck operation with its input schema. The agent does not need a per-help-desk adapter. Example prompt: Search Jentic for 'create support customer', load the /customer-support/customers schema, and execute with the user's name and email ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | /customer-support/customers | List customers on the connected support platform | | POST | /customer-support/customers | Create a new customer record | | GET | /customer-support/customers/{id} | Read a single customer by id | | PATCH | /customer-support/customers/{id} | Update a customer record | | DELETE | /customer-support/customers/{id} | Delete a customer record | ## Key resources - **Customers** — Create, list, read, update, and delete customer records on the connected support platform ## Why Jentic - **Setup:** Wiring the Apideck Customer Support API by hand means setting up its API key plus consumer and service headers, learning the unified customer shape, and normalising across support platforms yourself. Through Jentic you install once, import Apideck Customer Support from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** The Apideck Customer Support API puts the customer id in the URL path (/customer-support/customers/{id}), so a rule can pin your agent to reads and updates on customer records: it acts on the customer you name and nothing else. You choose the operations it may call, so delete is not included unless you add it. - **Credential handling:** Your Apideck API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'find a support customer' or 'update a customer record', and Jentic returns the matching Apideck Customer Support operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Zendesk Support API** — Native Zendesk Support API for customers running only on Zendesk - **Freshdesk API** — Native Freshdesk API for customers running only on Freshdesk - **Intercom API** — Native Intercom API for customers running only on Intercom - **Apideck CRM API** — Apideck CRM unified API to keep CRM contacts and support customers aligned ## FAQ ### What authentication does the Apideck Customer Support API use? Apideck requires Authorization with a bearer API key, x-apideck-app-id with your Unify application id, and x-apideck-consumer-id with the end-customer reference stored in Apideck Vault. Through Jentic all three values are stored encrypted in the vault and injected at execution time. ### Which support platforms does the Apideck Customer Support API cover? Apideck Unify routes Customer Support calls to connectors including Zendesk, Freshdesk, Intercom, HubSpot Service Hub, Help Scout, and Front. Use the x-apideck-service-id header to pin the call to a specific connector when a consumer has more than one connected. New POST methods can pass an X-Unique-Transaction-ID header to make creation calls idempotent. ### Can I create a customer record with the Apideck Customer Support API? Yes. POST to /customer-support/customers with the unified customer payload (first_name, last_name, emails, phone_numbers). Apideck translates the call into the native customer object on the connected support platform and returns the created record with the connector's id. ### What are the rate limits for the Apideck Customer Support API? Apideck enforces limits at both the Unify layer and the underlying connector. Each connected support platform has its own quota, so a /customer-support/customers call respects the downstream limit. Expect ConnectorRateLimitError on connector throttling and HTTP 429 on Unify throttling - retry with exponential backoff. ### How do I delete a customer through Jentic? Search Jentic for 'delete support customer', load the DELETE /customer-support/customers/{id} schema, and execute with the customer id. The response confirms the deletion on the connected support platform, which is useful for fulfilling GDPR right-to-erasure requests. ### Is the Apideck Customer Support API free? Apideck Unify offers a free tier with capped requests; production use is billed per consumer connection. See https://www.apideck.com/pricing for current tiers. ### Can I limit what my agent is allowed to do with the Apideck Customer Support API? Yes. Because you run Jentic One yourself, you decide which of the five customer operations your agent may call, so you can allow it to list and read customers and update records while withholding create and delete. The API puts the customer id in the URL path (/customer-support/customers/{id}), so your own rules can pin the agent to acting on the customer you name and nothing else. Delete is available only if you explicitly add it to the operations the agent is permitted to use.