Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Convert a customer

Converts a click on a website to a customer, complete with all website visitor information and partner attribution.

post/conversion/xid

Request body

xidstring required

Unique Click ID (if it's not unique, that's ok PS will accept it)

customer_keystring required

A unique identifier for the customer, this is the ID you will use to reference the customer in our API

emailstring

Optional. Due to privacy concerns you may want to supply anonymized values here

namestring

Optional, though you may supply a non-unique value that is the same for each customer (e.g. "ACME Customer")

customer_created_atinteger

The epoch second or millisecond timestamp for backdating the customer creation time

provider_keystring

If using Stripe, Chargebee, Recurly, Chargify webhook integration and the customer record is created in the payment platform before the customer is created in PartnerStack, you can pass the customer ID from the payment processor in the provider_key field

originstring

The origin of the signup

ip_addressstring

An IP address is a unique address that identifies a device on the internet or a local network of the customer

user_agentstring

The User-Agent request header is a string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent

external_typestring

External type takes any value that is being passed

sub_idsstring[]

A SubID is a string of alphanumeric characters generated at the end of a redirect URL, which records a user-defined variable

metaobject

Additional fields to be set on the customer (Note: Must match the api_name of your custom customer fields)

Example request

{
  "meta": {
    "custom_field_1": "example_value_1",
    "custom_field_2": "example_value_2"
  }
}

Response

200

statusinteger

Example response

{
  "status": 200
}