Update a partnership

patch https://api.partnerstack.com/api/v2/partnerships/{partnership_key}

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

Responses

Response body

object

data

object

required

Partners represent users on PartnerStack that will be promoting your company.

string

length ≤ 255

The email of the partner.

field_data

object | null

DEPRECATED 'fields' should be the source of truth

Has additional fields

fields

array of objects

fields

object

api_name

string

length ≤ 255

API name of this field to be used on create / update / serialization. Created at time of field creation but can be edited

external_type

string | null

Name that can be used for external systems

field_key

string

length ≤ 255

Key of field that is presented

help_text

string | null

The help text that is provided for this field

hidden

boolean

Whether or not this field is displayed when filling out its attached form

internal_name

string

length ≤ 255

Internal name of this field. Created by PartnerStack at time of field creation. Used when referencing field in created objects. Cannot be edited.

name

string

length ≤ 255

Name of field that is presented

options

object

Options to select from if this field is a picklist/checkbox

Has additional fields

placeholder_text

string | null

The text of the placeholder that is provided for this field

position

integer

The position that this field will be displayed in relation to others on the same form (index starts at 0)

required

boolean

Whether or not this field will be required when filling out its attached form

type

string

length ≤ 255

The type of field that will be presented (input, picklist, number ect.)

value

string

The value that was submitted to the field and stored on the target object

first_name

string

length ≤ 50

The first name of the partner.

fraud_flagged

boolean | null

Whether the partner has been flagged for fraud

last_name

string

length ≤ 50

The last name of the partner.

manager_email

string | null

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

manager_name

string | null

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

tags

group

object

Groups are a way to segment partners within PartnerStack to selectively distribute access to things such as Campaigns, Marketing Assets, and Rewards

tier

object

Tiers enable vendors to provide reward and feature levels.

message

string

required

status

int32

required

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.partnerstack.com/api/v2/partnerships/partnership_key \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

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

400Bad Request Error

401Unauthorized Error

403Forbidden Error

404Not Found Error

500Internal Server Error