Update partner information - agreements and preferences - Partner Referrals v1 (Deprecated)

API v2

API v1

Updates partner information - agreements and preferences - for the given partner.

Authorization

AuthorizationBearer <token>

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

Manage seller resources.https://uri.paypal.com/services/customer/partner

Path Parameters

Header Parameters

Content-typestringOptional

The Content-type header MUST be described in all externally-accessible APIs.

Match^.*$Length1 <= length <= 4000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

partner_idstringOptional

The account ID of the partner.

launch_typeenumOptional

Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.

Default"FULL_BROWSER"Value in"FULL_BROWSER" | "LIGHT_BOX" | "EMBEDDED" | "MINI_BROWSER"

receives_credentialbooleanOptional

Indicates whether the partner is integrated to receive a seller credential.

Defaultfalse

product_selectionenumOptional

Indicates whether the seller can select a product with which to integrate.

Allowed values

"Y"
"N"
"P"

logo_urlstringOptional

The partner logo URL. Provides a way for partners to update their logo through preferences. This logo over-writes any image URL provided earlier for their business accounts.

Formaturi

notification_urlstringOptional

The partner-provided URL for notifications.

Formaturi

integration_preferencesobject<product-integration>[]Optional

An array of required information for a partner to integrate this product. Varies based on the product to integrate.

region_preferencesobject<region-preferences>[]Optional

An array of region-specific preferences.

agreement_typesarray<agreement_types>Optional

An array of partner-accepted agreements.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/customer/partners/string" \  -H "Content-Type: application/json" \  -d '{}'

Empty

Path Parameters

Header Parameters

Content-typestringOptional

The Content-type header MUST be described in all externally-accessible APIs.

Match^.*$Length1 <= length <= 4000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

partner_idstringOptional

The account ID of the partner.

launch_typeenumOptional

Indicates whether the onboarding occurs in a full browser, mini-browser, or light box.

Default"FULL_BROWSER"Value in"FULL_BROWSER" | "LIGHT_BOX" | "EMBEDDED" | "MINI_BROWSER"

receives_credentialbooleanOptional

Indicates whether the partner is integrated to receive a seller credential.

Defaultfalse

product_selectionenumOptional

Indicates whether the seller can select a product with which to integrate.

Allowed values

"Y"
"N"
"P"

logo_urlstringOptional

The partner logo URL. Provides a way for partners to update their logo through preferences. This logo over-writes any image URL provided earlier for their business accounts.

Formaturi

notification_urlstringOptional

The partner-provided URL for notifications.

Formaturi

integration_preferencesobject<product-integration>[]Optional

An array of required information for a partner to integrate this product. Varies based on the product to integrate.

region_preferencesobject<region-preferences>[]Optional

An array of region-specific preferences.

agreement_typesarray<agreement_types>Optional

An array of partner-accepted agreements.

Update partner information - agreements and preferences

Authorization

Path Parameters

Header Parameters

Request Body

product-integration properties

region-preferences properties

product-preferences properties

message properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Update partner information - agreements and preferences

Authorization

Path Parameters

Header Parameters

Request Body

product-integration properties

region-preferences properties

product-preferences properties

message properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Update partner information - agreements and preferences

product-integration properties

region-preferences properties

product-preferences properties

message properties

204

400application/json

401application/json

404application/json

500application/json

defaultapplication/json

On this page

On this page

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Update partner information - agreements and preferences

product-integration properties

region-preferences properties

product-preferences properties

message properties

204

400application/json

401application/json

404application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`