curl --request PATCH \
--url https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentStructure": {
"paymentStructure": {}
},
"requirements": {
"platforms": [
"<string>"
],
"platformsOverride": true,
"minPosts": 123,
"maxPosts": 123,
"postFrequency": 123,
"contentGuidelines": "<string>",
"hashtagRequirements": [
"<string>"
],
"keywordRequirements": [
"<string>"
],
"mentionRequirements": [
"<string>"
],
"productRequirements": [
{
"id": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"shopName": "<string>"
}
]
}
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment"
payload = {
"paymentStructure": { "paymentStructure": {} },
"requirements": {
"platforms": ["<string>"],
"platformsOverride": True,
"minPosts": 123,
"maxPosts": 123,
"postFrequency": 123,
"contentGuidelines": "<string>",
"hashtagRequirements": ["<string>"],
"keywordRequirements": ["<string>"],
"mentionRequirements": ["<string>"],
"productRequirements": [
{
"id": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"shopName": "<string>"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentStructure: {paymentStructure: {}},
requirements: {
platforms: ['<string>'],
platformsOverride: true,
minPosts: 123,
maxPosts: 123,
postFrequency: 123,
contentGuidelines: '<string>',
hashtagRequirements: ['<string>'],
keywordRequirements: ['<string>'],
mentionRequirements: ['<string>'],
productRequirements: [
{id: '<string>', title: '<string>', imageUrl: '<string>', shopName: '<string>'}
]
}
})
};
fetch('https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'paymentStructure' => [
'paymentStructure' => [
]
],
'requirements' => [
'platforms' => [
'<string>'
],
'platformsOverride' => true,
'minPosts' => 123,
'maxPosts' => 123,
'postFrequency' => 123,
'contentGuidelines' => '<string>',
'hashtagRequirements' => [
'<string>'
],
'keywordRequirements' => [
'<string>'
],
'mentionRequirements' => [
'<string>'
],
'productRequirements' => [
[
'id' => '<string>',
'title' => '<string>',
'imageUrl' => '<string>',
'shopName' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment"
payload := strings.NewReader("{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "<string>",
"contractId": "<string>",
"contractorId": "<string>",
"contractorName": "<string>",
"companyId": "<string>",
"programId": "<string>",
"contractStatus": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"pdfRegenerated": true,
"pdfRegenerationError": "<string>",
"pendingCreatorContractUpdate": true,
"changeSummary": "<string>",
"templateLiteralsRewritten": {
"replacementCount": 123,
"byField": {}
}
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Update a contract's payment structure
Update a contract’s payment structure. Requires the contracts:write scope.
curl --request PATCH \
--url https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"paymentStructure": {
"paymentStructure": {}
},
"requirements": {
"platforms": [
"<string>"
],
"platformsOverride": true,
"minPosts": 123,
"maxPosts": 123,
"postFrequency": 123,
"contentGuidelines": "<string>",
"hashtagRequirements": [
"<string>"
],
"keywordRequirements": [
"<string>"
],
"mentionRequirements": [
"<string>"
],
"productRequirements": [
{
"id": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"shopName": "<string>"
}
]
}
}
'import requests
url = "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment"
payload = {
"paymentStructure": { "paymentStructure": {} },
"requirements": {
"platforms": ["<string>"],
"platformsOverride": True,
"minPosts": 123,
"maxPosts": 123,
"postFrequency": 123,
"contentGuidelines": "<string>",
"hashtagRequirements": ["<string>"],
"keywordRequirements": ["<string>"],
"mentionRequirements": ["<string>"],
"productRequirements": [
{
"id": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"shopName": "<string>"
}
]
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
paymentStructure: {paymentStructure: {}},
requirements: {
platforms: ['<string>'],
platformsOverride: true,
minPosts: 123,
maxPosts: 123,
postFrequency: 123,
contentGuidelines: '<string>',
hashtagRequirements: ['<string>'],
keywordRequirements: ['<string>'],
mentionRequirements: ['<string>'],
productRequirements: [
{id: '<string>', title: '<string>', imageUrl: '<string>', shopName: '<string>'}
]
}
})
};
fetch('https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'paymentStructure' => [
'paymentStructure' => [
]
],
'requirements' => [
'platforms' => [
'<string>'
],
'platformsOverride' => true,
'minPosts' => 123,
'maxPosts' => 123,
'postFrequency' => 123,
'contentGuidelines' => '<string>',
'hashtagRequirements' => [
'<string>'
],
'keywordRequirements' => [
'<string>'
],
'mentionRequirements' => [
'<string>'
],
'productRequirements' => [
[
'id' => '<string>',
'title' => '<string>',
'imageUrl' => '<string>',
'shopName' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment"
payload := strings.NewReader("{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.sideshift.app/api/oauth/v1/contracts/{id}/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"paymentStructure\": {\n \"paymentStructure\": {}\n },\n \"requirements\": {\n \"platforms\": [\n \"<string>\"\n ],\n \"platformsOverride\": true,\n \"minPosts\": 123,\n \"maxPosts\": 123,\n \"postFrequency\": 123,\n \"contentGuidelines\": \"<string>\",\n \"hashtagRequirements\": [\n \"<string>\"\n ],\n \"keywordRequirements\": [\n \"<string>\"\n ],\n \"mentionRequirements\": [\n \"<string>\"\n ],\n \"productRequirements\": [\n {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"imageUrl\": \"<string>\",\n \"shopName\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"success": true,
"message": "<string>",
"contractId": "<string>",
"contractorId": "<string>",
"contractorName": "<string>",
"companyId": "<string>",
"programId": "<string>",
"contractStatus": "<string>",
"fileUrl": "<string>",
"fileName": "<string>",
"pdfRegenerated": true,
"pdfRegenerationError": "<string>",
"pendingCreatorContractUpdate": true,
"changeSummary": "<string>",
"templateLiteralsRewritten": {
"replacementCount": 123,
"byField": {}
}
}
}{
"error": {
"code": "unauthorized",
"message": "Missing bearer access token",
"requestId": "req_..."
}
}{
"error": {
"code": "insufficient_scope",
"message": "Requires scope 'campaigns:write'",
"requestId": "req_..."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found",
"requestId": "req_..."
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded",
"requestId": "req_..."
}
}Authorizations
OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.
Path Parameters
The id.
Body
Update contract payment terms and/or requirements. At least one of paymentStructure or requirements must be provided.
A payment structure. On PUT, the body is forwarded to the campaign update service verbatim (cpmRate >= 0 normalization + crosspostMaturityDays validation are reused from the canonical service). Permissive.
Show child attributes
Show child attributes
Contract / campaign delivery requirements. Passed through to the contract un-strictly (the route does not strictly validate the body); the listed fields mirror the MCP programRequirementsSchema cross-check (lib/mcp/tools/structure-schemas.ts:94).
Show child attributes
Show child attributes
Response
Result of the payment-terms update, including regen status and pending-review flag.
Show child attributes
Show child attributes