SparkLoop
  • API v2
    • Endpoints
      • Subscribers
        • Events
      • Referral Campaigns
        • Campaign Memberships
        • Subscribers
      • Partner Profile
        • Recommendations
        • Payouts
      • Publications
      • Upscribe
        • Recommendations
      • Partner Programs
      • Partner Network
        • Publications
        • Partner Programs
      • Webhooks
    • Schemas
      • Partner Profile Object
      • Partner Program Object
      • Publication Object
      • Subscriber Object
      • Campaign Object
      • Upscribe Object
      • Recommendation Object
    • Guides
      • How to use Upscribe via API
  • API v1
    • Campaigns
    • Subscribers
    • Events
    • Webhooks
  • Webhooks
  • Changelog
Powered by GitBook
On this page
  • Create a campaign membership
  • Delete a campaign membership.

Was this helpful?

  1. API v2
  2. Endpoints
  3. Referral Campaigns

Campaign Memberships

Campaign Memberships handle the relationship between subscribers and referral programs. For example, to add a subscriber to a referral program you must create a Campaign Membership relationship.

Create a campaign membership

POST https://api.sparkloop.app/v2/campaigns/:identifier/campaign_memberships

Use to endpoint to add a subscriber to a referral program

Path Parameters

Name
Type
Description

:identifier*

String

Referral campaign UUID, e.g. MF9a78983d1c.

Request Body

Name
Type
Description

subscriber_uuid*

string

Subscriber's UUID or email address

{
    "campaign_membership": {
        "uuid": "membership_0cf7ec1e76d1",
        "campaign_uuid": "MF3c31fb034e",
        "subscriber_uuid": "sub_509eafef8d9d",
        "created_at": "2022-12-19T14:45:30.593Z"
    }
}
{
    "error": "manuel@sparkloop.app has already been added to this campaign"
}
{
    "error": "manuel@sparkloop not found!"
}

Delete a campaign membership.

DELETE https://api.sparkloop.app/v2/campaigns/:identifier/campaign_memberships/:uuid

Use this endpoint to remove a subscriber from a campaign.

Path Parameters

Name
Type
Description

:identifier*

string

Subscriber's Referral campaign UUID, e.g. MF9a78983d1c.UUID or email address

:uuid*

String

Membership's UUID.

{
    "message": "Successfully deleted membership membership_34c8e39cf4"
}
{
    "error": "Failed to delete membership_34c8e39cf4"
}
{
    "error": "Membership membership_34c8e39cf4 not found!"
}
{
    "error": "Campaign MF9a7d8983d1c not found!"
}
PreviousReferral CampaignsNextSubscribers

Last updated 8 months ago

Was this helpful?