Partner Programs

Get Partner Programs

GET https://api.sparkloop.app/v2/partner_network/partner_programs

Partner programs are ordered in descending order by created_at, meaning the first page shows the latest partner programs.

Query Parameters

Name	Type	Description
page	string	Page for paginated results
per_page	string	Number of results per page. Default is 50, max is 200.

200 Used query params ?page=2&per_page=10

{
  "partner_programs": [
    <Partner Program Object>,
    <Partner Program Object>,
    <Partner Program Object>,
  ],
  "meta": {
    "per_page": 10,
    "page": 2,
    "total_pages": 4,
    "total_partner_programs": 48
  }
}

Get a partner program

GET https://api.sparkloop.app/v2/partner_network/partner_programs/:uuid

Returns a single partner program by UUID

Path Parameters

Name	Type	Description
uuid*	string	Partner program's UUID

200

{
  "partner_program": <Partner Program Object>
}

404: Not Found

Partner program not found

{
    "error": "Partner program partner_program_45e5187ede44 not found."
}

Join partner program

POST https://api.sparkloop.app/v2/partner_network/partner_programs/:uuid/join

Use this endpoint to join a partner program.

Path Parameters

Name	Type	Description
uuid*	string	Partner program's UUID

Request Body

Name	Type	Description
status	string	Subscriber's status. Allowed values are unsubscribed and confirmed.
name	string	Subscriber's name.
email	string	Subscriber's email address.

200 Returns the subscriber.

{
    "partner_campaign": <Partner Campaign Object>
}

400

Unsupported status

{
    "error": "Some error"
}

Empty PUT body

{
    "error": "You have to update at least 1 field."
}