Update
curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"updateMask": "<string>"
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}"
payload = {
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"updateMask": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rule: {
createdAt: '2023-11-07T05:31:56Z',
displayName: '<string>',
grant: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
},
groupRef: {appId: '<string>', id: '<string>'},
reason: '<string>',
ruleId: '<string>',
tenantId: '<string>',
updatedAt: '2023-11-07T05:31:56Z'
},
updateMask: '<string>'
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}', 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://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rule' => [
'createdAt' => '2023-11-07T05:31:56Z',
'displayName' => '<string>',
'grant' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
],
'groupRef' => [
'appId' => '<string>',
'id' => '<string>'
],
'reason' => '<string>',
'ruleId' => '<string>',
'tenantId' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z'
],
'updateMask' => '<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://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}"
payload := strings.NewReader("{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Fund Rules
Update
Update replaces the group, grant, label or reason on one rule, whichever the field mask names. The new grant governs the next acquire; spend already accounted for against the old one is not revisited.
POST
/
api
/
v1
/
funds
/
rules
/
{rule_id}
Update
curl --request POST \
--url https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"updateMask": "<string>"
}
'import requests
url = "https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}"
payload = {
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": { "money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
} },
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
},
"updateMask": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
rule: {
createdAt: '2023-11-07T05:31:56Z',
displayName: '<string>',
grant: {
amount: {money: {currencyCode: '<string>', nanos: 123, units: '<string>'}},
blocked: {},
unlimited: {}
},
groupRef: {appId: '<string>', id: '<string>'},
reason: '<string>',
ruleId: '<string>',
tenantId: '<string>',
updatedAt: '2023-11-07T05:31:56Z'
},
updateMask: '<string>'
})
};
fetch('https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}', 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://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rule' => [
'createdAt' => '2023-11-07T05:31:56Z',
'displayName' => '<string>',
'grant' => [
'amount' => [
'money' => [
'currencyCode' => '<string>',
'nanos' => 123,
'units' => '<string>'
]
],
'blocked' => [
],
'unlimited' => [
]
],
'groupRef' => [
'appId' => '<string>',
'id' => '<string>'
],
'reason' => '<string>',
'ruleId' => '<string>',
'tenantId' => '<string>',
'updatedAt' => '2023-11-07T05:31:56Z'
],
'updateMask' => '<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://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}"
payload := strings.NewReader("{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}.conductor.one/api/v1/funds/rules/{rule_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rule\": {\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"displayName\": \"<string>\",\n \"grant\": {\n \"amount\": {\n \"money\": {\n \"currencyCode\": \"<string>\",\n \"nanos\": 123,\n \"units\": \"<string>\"\n }\n },\n \"blocked\": {},\n \"unlimited\": {}\n },\n \"groupRef\": {\n \"appId\": \"<string>\",\n \"id\": \"<string>\"\n },\n \"reason\": \"<string>\",\n \"ruleId\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n },\n \"updateMask\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"rule": {
"createdAt": "2023-11-07T05:31:56Z",
"displayName": "<string>",
"grant": {
"amount": {
"money": {
"currencyCode": "<string>",
"nanos": 123,
"units": "<string>"
}
},
"blocked": {},
"unlimited": {}
},
"groupRef": {
"appId": "<string>",
"id": "<string>"
},
"reason": "<string>",
"ruleId": "<string>",
"tenantId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.
Path Parameters
The ruleId field.
Body
application/json
Response
200 - application/json
Successful response
The FundRuleServiceUpdateResponse message.
FundRule is one group grant as the API renders it.
Show child attributes
Show child attributes
Was this page helpful?