PerfectWorks
  1. Referrer Campaigns
PerfectWorks
  • Organizations
    • Register new organization
      POST
    • List user's organizations
      GET
    • Get current organization details
      GET
    • Update organization profile
      PUT
    • Get organization statistics
      GET
    • Get organization by slug (public)
      GET
    • Soft delete organization
      DELETE
    • Permanently delete organization
      DELETE
  • Files
    • Generate signed upload URL
      POST
    • Create file record
      POST
    • List files
      GET
    • Get file by ID
      GET
    • Update file
      PUT
    • Delete file
      DELETE
    • Generate download URL
      POST
    • Analyze file
      POST
    • Process file for accessibility
      POST
    • Convert file to different format
      POST
  • API Keys
    • Create a new API key
      POST
    • List user's API keys
      GET
    • Get API key by ID
      GET
    • Update API key description
      PUT
    • Delete API key
      DELETE
  • Referrers
    • Join referral program
    • Get referrer profile
    • Get referrer dashboard
  • Referrer Transactions
    • List referrer's transactions
    • Get transaction details
    • Request withdrawal from pending earnings
  • Referrer Campaigns
    • Create referral campaign
      POST
    • List referrer's campaigns
      GET
    • Get campaign details
      GET
    • Update campaign
      PUT
    • End campaign
      DELETE
    • Get campaign analytics
      GET
  • Referral Links
    • Track referral click and redirect
  • Payments
    • Create a checkout session
    • Get checkout session details
    • Get available products
  • Users
    • Register new client user
    • Register system user
    • Get user profile
    • Update user profile
    • Soft delete user account
    • Permanently delete user account
    • Switch active organization
    • Get current active organization
  • Token Transactions
    • List organization token transactions
    • Get organization token balance
    • Get token transaction by ID
  • Organization Members
    • Invite new member to organization
    • List organization members
    • Get user's pending organization invitations
    • Get member details
    • Remove organization member
    • Join organization with pending invitation
  1. Referrer Campaigns

Create referral campaign

POST
/referrer-campaigns
Create a new referral campaign for the authenticated organization.
Generates a unique campaign code automatically for tracking purposes.
Only organizations registered as referrers can create campaigns.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.perfectworks.io/api/v0/referrer-campaigns' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Q1 2024 Marketing Push",
    "description": "Targeting small businesses for document accessibility services"
}'
Response Response Example
201 - Example 1
{
    "success": true,
    "message": "Operation completed successfully",
    "data": {
        "id": "123",
        "name": "Example"
    }
}

Request

Authorization
or
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/json

Examples

Responses

🟢201Created
application/json
Campaign created successfully
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Modified at 2025-08-22 18:48:44
Previous
Request withdrawal from pending earnings
Next
List referrer's campaigns