Skip to main content
PATCH
/
v1
/
affiliation_requests
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/affiliation_requests/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "affiliation_request": {
    "bio": "I have lots of followers!"
  }
}
'
{
  "id": "7bc54587-a6d7-4dce-a84a-a96f478fa1a9",
  "object": "affiliation_request",
  "bio": "I have lots of followers!",
  "email": "[email protected]",
  "first_name": "Test",
  "last_name": "Affiliate 4",
  "metadata": {},
  "payout_email": null,
  "status": "pending",
  "url": null,
  "portal_url": "http://app.example.com/portal_redirect/affiliation_requests/7bc54587-a6d7-4dce-a84a-a96f478fa1a9",
  "created_at": 1767909665,
  "updated_at": 1767909665
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
affiliation_request
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
bio
string

A short blurb from this affiliate describing how they will promote this store.

​
email
string

The affiliate's email address.

​
first_name
string

The affiliate's first name.

​
last_name
string | null

The affiliate's last name.

​
payout_email
string | null

The affiliate's payout email address.

​
url
string | null

The primary website or social media account of the affiliate.

​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
portal_url
string | null

A URL that will redirect to this affiliation request's correct portal page (hosted or external).

​
status
string

The current status of this affiliation request, which can be one of approved, denied, or pending.

​
used
boolean

Whether or not the request has been used to register an affiliate.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.