API Reference

Identify a customer

post
https://appapi.heymantle.com/v1/identify
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Platform this app is running on. shopify, web, etc.

string

Unique identifier for the customer on the platform. For Shopify this is the shop ID.

string

Name of the plan the customer is on for the platform. For Shopify this is the plan name.

string

Shopify domain of the customer when platform is Shopify

string

Shopify access token for the customer when platform is Shopify

string

Email of the customer

date-time

Date the customer was created, signed up, or installed the app

customFields
object

Custom fields to store additional information about the customer

string

Name of the customer

string

Country code of the customer

boolean

Whether to rotate the API token

string

Default billing provider for the customer. If this value is "stripe", and no platformId is provided, the platformId will be the stripeId.

string

Customer support email when platform is Shopify

tags
array of strings

Array of tags to add to the customer. If the customer already exists the tags will be replaced by default. See "operators.tags" for other options.

tags
operators
object

Operators for customer level operations.

string

If provided, finds any existing app installations with this platformId and merges them into the current installation. Useful for consolidating customers when their platform identifier changes (e.g. migrating from one billing system to another).

contacts
array of objects

Array of contact objects

contacts
Headers
string
required

The App Id when you create an API key in your Mantle dashboard.

string
required

The API key found in the Mantle dashboard. This is used to identify your users to Mantle and should be kept secret, and used only in server-side code.

Responses

500

Internal Server Error

Updated 4 months ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?