The Customer Links API from Imprint — 1 operation(s) for customer links.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/imprint:imprint-customer-links-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Public Imprint Customer Links API
version: '2.0'
servers:
- url: https://dev.sbx.imprint.co
description: Imprint public api sandbox
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Customer Links
paths:
/v2/customers/{customer_id}/link:
post:
tags:
- Customer Links
summary: Link an Imprint customer and partner customer accounts
description: Creates a link between an existing Imprint customer and a partner's customer account. The API key provided with the request will be used to link the partner with the imprint customer.
operationId: linkCustomerAccount
parameters:
- name: customer_id
in: path
required: true
description: The unique identifier for the Imprint customer
schema:
type: string
example: BBB815E9-F654-438D-9AD3-3F7BB8136FC0
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- partner_customer_id
properties:
partner_customer_id:
$ref: '#/components/schemas/PartnerCustomerId'
metadata:
type: object
description: Additional linking metadata
additionalProperties: true
example:
store_id: store_789
platform_version: 2.1.0
responses:
'200':
description: Customer accounts linked successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerLink'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestError'
'404':
description: Customer not found
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerNotFoundError'
'409':
description: Customer already linked. To change the linked `partner_customer_id`, use `PATCH /v2/customers/{customer_id}/link`.
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- type
- message
properties:
type:
type: string
description: Error type (e.g., CUSTOMER_ALREADY_LINKED)
message:
type: string
example: Customer already linked to a partner account
existing_link:
$ref: '#/components/schemas/CustomerLink'
patch:
tags:
- Customer Links
summary: Update the partner customer ID of a customer link
description: Changes the `partner_customer_id` of the customer's existing active link to a new value. Use this when the partner customer account an Imprint customer is linked to has changed, for example after a partner account merge. The link must already exist and be active; to create a link, use `POST /v2/customers/{customer_id}/link`. If the provided `partner_customer_id` already matches the active link, the link is returned unchanged. A successful change sends a `CUSTOMER_LINK` webhook with the new `partner_customer_id`.
operationId: updateCustomerLink
parameters:
- name: customer_id
in: path
required: true
description: The unique identifier for the Imprint customer
schema:
type: string
example: BBB815E9-F654-438D-9AD3-3F7BB8136FC0
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- partner_customer_id
properties:
partner_customer_id:
$ref: '#/components/schemas/PartnerCustomerId'
metadata:
type: object
description: Additional linking metadata
additionalProperties: true
example:
store_id: store_789
platform_version: 2.1.0
responses:
'200':
description: Customer link updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerLink'
'400':
description: Invalid request
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestError'
'404':
description: Customer not found, or the customer has no active link to update
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerNotFoundError'
components:
schemas:
CustomerNotFoundError:
type: object
required:
- type
- message
properties:
type:
type: string
description: The category of error being returned
example: CUSTOMER_NOT_FOUND_ERROR
message:
type: string
description: A message describing the cause of the error
example: 'Customer not found for provided ID: CSMR-v1-123'
param:
type: string
description: The param causing the error
example: customer_id
CustomerLink:
type: object
required:
- customer_id
- partner_customer_id
- status
- created_at
properties:
customer_id:
type: string
example: 9B5E1EE0-2E1C-46E7-81B9-3C3917204BE4
description: The ID of the Imprint customer
partner_customer_id:
$ref: '#/components/schemas/PartnerCustomerId'
status:
type: string
enum:
- ACTIVE
- INACTIVE
example: ACTIVE
description: Status of the linked relationship
created_at:
type: string
description: the RFC-3339 timestamp when the link was created at.
example: 2025-02-13 19:08:07+00:00
updated_at:
type: string
description: the RFC-3339 timestamp when the link was last updated.
example: 2025-02-13 19:08:07+00:00
metadata:
type: object
description: Additional linking metadata
additionalProperties: true
example:
store_id: store_789
platform_version: 2.1.0
InvalidRequestError:
type: object
properties:
path:
type: string
description: The path of the endpoint returning the error
example: /v2/customers
details:
type: array
items:
type: string
description: The details of the error being returned
example:
- 'email: must be a well-formed email address'
error:
type: string
description: The category of error being returned
example: Bad Request
status:
type: integer
description: The HTTP status code of the error
example: 400
timestamp:
type: string
description: The timestamp that the error occurred
example: '2025-01-20T18:18:22.923+00:00'
PartnerCustomerId:
type: string
minLength: 1
maxLength: 128
pattern: ^[\x20-\x7E]+$
description: 'The unique identifier for the customer in the partner''s system.
Compared byte-for-byte, so `PARTNER_USER_456` and `partner_user_456` are
two different customers. Send the same casing everywhere or a later
lookup silently returns no match.
Restricted to printable ASCII (`\x20`–`\x7E`) rather than arbitrary
UTF-8: the value is propagated between internal services as an HTTP/2
header, which cannot carry non-ASCII bytes. The bound is published
rather than discovered.
'
example: PARTNER_USER_456
securitySchemes:
basicAuth:
type: http
scheme: basic
description: 'Basic HTTP authentication. Allowed headers-- Authorization: Basic <base64(api_key_id:api_key_secret)>'
bearerAuth:
bearerFormat: auth-scheme
description: 'Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>'
scheme: bearer
type: http
x-provenance:
method: harvested
publisher: Imprint
source: https://docs.imprint.co/api-reference/openapi.yaml
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)