Sign in

v1

latestOpenAPI 3.0.22026-07-24800528.1 KB
Partnerships

Create a partnership

Creates a new partnership with the data provided. The claimed field will default to false until the partner claims the partnership.

post/v2/partnerships

Request body

claimedboolean nullable

Whether the partnership has been claimed by the partner.

claimed_atinteger nullable

When the partnership was claimed by the partner.

emailstring email required

The email of the partner.

field_dataobject nullable

DEPRECATED 'fields' should be the source of truth

first_namestring

The first name of the partner.

fraud_flaggedboolean nullable

Whether the partner has been flagged for fraud

group_join_dateinteger nullable

Timestamp of when the partner joined their current group. This will update if they move groups.

last_namestring

The last name of the partner.

manager_emailstring email nullable

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

manager_namestring nullable

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

metaobject nullable

DEPRECATED 'fields' should be the source of truth

partner_keystring

The partner_key you wish to use for this partner. If included, must be unique to this partner. For more information on partner_key see PartnerStackJS. Note that the partner_key can only consist of letters, numbers, and underscores.

program_join_dateinteger nullable

Timestamp of when the partner was approved to join the program. This does not change if they move groups.

tagsstring[] nullable
group_keystring

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

notify_by_emailboolean nullable

Whether to send a verification email to the partner.

Example request

{
  "claimed_at": 1614000000,
  "email": "johnsmith@gmail.com",
  "fields": [
    {
      "field_key": "field_fjkdlrh9i32nfew",
      "name": "Company Address"
    }
  ],
  "first_name": "John",
  "last_name": "Smith",
  "manager_email": "alicebaz@gmail.com",
  "manager_name": "Alice Baz",
  "partner_key": "gstest",
  "group_key": "gr_2384jh348234y"
}

Response

Creates a new partnership with the data provided. The claimed field will default to false until the partner claims the partnership.

messagestring required
statusinteger required

Example response

{
  "data": {
    "created_at": 1574181282399,
    "key": "co_a80cb515fe",
    "updated_at": 1574181282399,
    "claimed_at": 1614000000,
    "email": "johnsmith@gmail.com",
    "fields": [
      {
        "field_key": "field_fjkdlrh9i32nfew",
        "name": "Company Address"
      }
    ],
    "first_name": "John",
    "last_name": "Smith",
    "manager_email": "alicebaz@gmail.com",
    "manager_name": "Alice Baz",
    "partner_key": "gstest",
    "group": {
      "created_at": 1574181282399,
      "key": "co_a80cb515fe",
      "updated_at": 1574181282399,
      "name": "Resellers",
      "slug": "resellers"
    },
    "tier": {
      "key": "tag_a80cb515fe",
      "name": "Tier 1"
    }
  }
}