Create Partnership

post

https://api.partnerstack.com/v1/partnerships/{public_key}

Creates a partnership with desired params

Path Params

public_key

string

required

Your live production public key found in your integration settings.

Body Params

address

object

The address of the person you want to create a partnership with.

string

required

length ≤ 200

The email of the person you want to create a partnership with.

first_name

string

length ≤ 50

The first name of the person you want to make a partnership with.

group

string

length ≤ 255

The name of the group within PartnerStack that you want this partner to be placed into.

joined_at

string

The date that this partner joined your program.

last_name

string

length ≤ 50

The last name of the person you want to make a partnership with.

manager_email

string

length ≤ 255

The email of the Partner Manager who you wish to manage this partner.

metadata

object

An internal reference that you wish to apply to this partnership for tracking purposes.

partner_key

string

The partner_key that you want to assign to this partner, note that this must be unique from any other partner_key in your program. If left empty PartnerStack will create a partner_key.

phone_number

string

The phone number of the person you want to create a partnership with.

tier

string

The name of the tier that this person belongs to in your program

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Partnership

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error