COPS
Brand API

Update payout structure

PATCH
/payout-structures/{id}

Update a payout structure (only the fields you pass change). config is replaced, not merged — send the full rule set from get_payout_structure. Changes what every campaign and creator on this structure is owed. Set isActive: false to archive it.

Authorization

apiKeyAuth
headerx-api-key<token>

API key for authentication. Keys are prefixed with cops_.

Path Parameters

id*string
Match^pst_.+[\s\S]*$

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 PATCH 'https://cops.app/api/brand/payout-structures/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty

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.

Delete payout structure DELETE

Permanently delete a payout structure, clearing it from the campaigns and creator assignments using it. Blocked if any payout references it — archive with isActive: false instead. Returns the deleted structure.