v1

latestOpenAPI 3.0.22026-07-24800528.1 KB

Partnerships

Update a partnership

Updates the specific partnership by setting the values of the parameters passed.

patch/v2/partnerships/{partnership_key}

Path parameters

partnership_keystring required

The specific key for the partnership

Request body

group_keystring

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

manager_emailstring nullable

The email of the partner manager that you would like to assign this partner.

partner_keystring nullable

The partner_key that you would like this partner to have.

tier_keystring nullable

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

Example request

{
  "fields": [
    {
      "api_name": "company_size",
      "value": 5000
    }
  ],
  "group_key": "gr_2384jh348234y",
  "manager_email": "partnermanager@company.com",
  "partner_key": "gstest",
  "tier_key": "tier_UWjSmVBIxRQoaP"
}

Response

Updates the specific partnership by setting the values of the parameters passed.

messagestring required

statusinteger required

Example response

{
  "data": {
    "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"
    }
  }
}