COPS
Brand API

Create payout structure

POST
/payout-structures

Create a payout structure — a rate card built from earning rules (base pay, per post, per 1,000 views, milestone bonuses) plus optional view modifiers and gates. At least one earning rule is required; money is integer cents. Attach it to a campaign with update_campaign.

Authorization

apiKeyAuth
headerx-api-key<token>

API key for authentication. Keys are prefixed with cops_.

Request Body

application/json
  1. body
name*string
Length1 <= length
config*
description?string|unknown
paymentFrequency*string
Value in"weekly""biweekly""semi_monthly""monthly""custom""apple"
paymentScheduleConfig?
paymentStartDate*string
Formatdate
isActive?boolean

Response Body

Response schema unavailable.

Example Request
curl -X POST 'https://cops.app/api/brand/payout-structures' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "config": {    "version": 2,    "viewsBasis": "sum",    "rules": {}  },  "paymentFrequency": "weekly",  "paymentStartDate": "2019-08-24"}'
Example Response200
Empty

List payout structures GET

List your organization's payout structures — the rule sets that turn a creator's posts and views into an amount owed. Active only, unless you pass includeArchived.

Get payout structure GET

Get one payout structure with its full rule set and payment schedule. Money is integer cents. Pass an id from list_payout_structures.