Return a borrowed account
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/account-shares/return \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"to_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_over_slot": {
"eq": true
},
"end_reason": {
"in": [],
"is_null": true
},
"failure_reason": {
"in": [],
"is_null": true
},
"owner_cluster_id": {
"eq": 123,
"in": [
123
]
},
"holder_cluster_id": {
"eq": 123,
"in": [
123
]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"confirmation_count": 1
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/account-shares/return"
payload = {
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"to_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_over_slot": { "eq": True },
"end_reason": {
"in": [],
"is_null": True
},
"failure_reason": {
"in": [],
"is_null": True
},
"owner_cluster_id": {
"eq": 123,
"in": [123]
},
"holder_cluster_id": {
"eq": 123,
"in": [123]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"confirmation_count": 1
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sid: '<string>',
filter: {
sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
status: {in: [], nin: []},
to_team_sid: {eq: '<string>', in: ['<string>']},
to_user_sid: {eq: '<string>', in: ['<string>']},
owner_account_sid: {eq: '<string>', in: ['<string>']},
holder_account_sid: {eq: '<string>', in: ['<string>']},
holder_over_slot: {eq: true},
end_reason: {in: [], is_null: true},
failure_reason: {in: [], is_null: true},
owner_cluster_id: {eq: 123, in: [123]},
holder_cluster_id: {eq: 123, in: [123]},
phase_claimed_at: {gte: '<string>', lte: '<string>', is_null: true},
planned_return_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
confirmation_count: 1
})
};
fetch('https://app.gtm-api.com/id/v4/api/account-shares/return', 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.gtm-api.com/id/v4/api/account-shares/return",
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([
'sid' => '<string>',
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'status' => [
'in' => [
],
'nin' => [
]
],
'to_team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'to_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_over_slot' => [
'eq' => true
],
'end_reason' => [
'in' => [
],
'is_null' => true
],
'failure_reason' => [
'in' => [
],
'is_null' => true
],
'owner_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'holder_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'phase_claimed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'planned_return_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'confirmation_count' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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.gtm-api.com/id/v4/api/account-shares/return"
payload := strings.NewReader("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://app.gtm-api.com/id/v4/api/account-shares/return")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/account-shares/return")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"to_team_sid": "<string>",
"to_user_sid": "<string>",
"to_email": "<string>",
"owner_cluster_id": 123,
"holder_cluster_id": 123,
"owner_account_sid": "<string>",
"owner_channel_ref": "<string>",
"holder_account_sid": "<string>",
"holder_channel_ref": "<string>",
"holder_over_slot": true,
"planned_return_at": "<string>",
"expiry_notified_at": "<string>",
"phase_claimed_at": "<string>",
"phase_attempts": 123,
"ended_at": "<string>",
"ended_by": {
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_by": {
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
},
"result": {
"closing_count": 1,
"total_matched": 1
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"credits": {
"charged": 1,
"balance_after": 1
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}account_shares
Return a borrowed account
Give a borrowed account back early. Holder side. Same shape as recall_account_share: EXACTLY ONE of sid (ac_sh_) or filter, filter mode server-pinned to status active, drained INLINE at most 100 shares per call with no mass-action row minted, and confirmation_count required with filter and matched against the active-pinned pagination.total_count of list_received_account_shares (409 confirmation_count_mismatch otherwise). The difference is the side: the filter resolves over the loans you RECEIVED, and a share you do not hold is 403 not_share_holder. ASYNC: it stamps status closing, then the driver tears the holder copy down and un-parks the owner, so closing_count counts shares that STARTED closing; poll status to returned. Not atomic, and the same remainder and recount rule as recall. Deleting the borrowed copy on the channel has the same effect, ending the loan with end_reason holder_deleted_copy. Needs can_manage_account_shares.
Contract:
- MCP tool
return_account_share, registry packagemcp.id/account_shares, mountid.access. - Operation
action, response envelopeaction. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API; mass action: this verb’s own request accepts a filter or targets[] set, which the owning service drains.
POST
/
api
/
account-shares
/
return
Return a borrowed account
curl --request POST \
--url https://app.gtm-api.com/id/v4/api/account-shares/return \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"to_user_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"owner_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_account_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"holder_over_slot": {
"eq": true
},
"end_reason": {
"in": [],
"is_null": true
},
"failure_reason": {
"in": [],
"is_null": true
},
"owner_cluster_id": {
"eq": 123,
"in": [
123
]
},
"holder_cluster_id": {
"eq": 123,
"in": [
123
]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"confirmation_count": 1
}
'import requests
url = "https://app.gtm-api.com/id/v4/api/account-shares/return"
payload = {
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"status": {
"in": [],
"nin": []
},
"to_team_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"to_user_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"owner_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_account_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"holder_over_slot": { "eq": True },
"end_reason": {
"in": [],
"is_null": True
},
"failure_reason": {
"in": [],
"is_null": True
},
"owner_cluster_id": {
"eq": 123,
"in": [123]
},
"holder_cluster_id": {
"eq": 123,
"in": [123]
},
"phase_claimed_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"planned_return_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
}
},
"confirmation_count": 1
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sid: '<string>',
filter: {
sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
status: {in: [], nin: []},
to_team_sid: {eq: '<string>', in: ['<string>']},
to_user_sid: {eq: '<string>', in: ['<string>']},
owner_account_sid: {eq: '<string>', in: ['<string>']},
holder_account_sid: {eq: '<string>', in: ['<string>']},
holder_over_slot: {eq: true},
end_reason: {in: [], is_null: true},
failure_reason: {in: [], is_null: true},
owner_cluster_id: {eq: 123, in: [123]},
holder_cluster_id: {eq: 123, in: [123]},
phase_claimed_at: {gte: '<string>', lte: '<string>', is_null: true},
planned_return_at: {
gte: '<string>',
lte: '<string>',
gt: '<string>',
lt: '<string>',
is_null: true
},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'}
},
confirmation_count: 1
})
};
fetch('https://app.gtm-api.com/id/v4/api/account-shares/return', 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.gtm-api.com/id/v4/api/account-shares/return",
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([
'sid' => '<string>',
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'status' => [
'in' => [
],
'nin' => [
]
],
'to_team_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'to_user_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'owner_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_account_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'holder_over_slot' => [
'eq' => true
],
'end_reason' => [
'in' => [
],
'is_null' => true
],
'failure_reason' => [
'in' => [
],
'is_null' => true
],
'owner_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'holder_cluster_id' => [
'eq' => 123,
'in' => [
123
]
],
'phase_claimed_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'planned_return_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
]
],
'confirmation_count' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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.gtm-api.com/id/v4/api/account-shares/return"
payload := strings.NewReader("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://app.gtm-api.com/id/v4/api/account-shares/return")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/id/v4/api/account-shares/return")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"status\": {\n \"in\": [],\n \"nin\": []\n },\n \"to_team_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"to_user_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"owner_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_account_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"holder_over_slot\": {\n \"eq\": true\n },\n \"end_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"failure_reason\": {\n \"in\": [],\n \"is_null\": true\n },\n \"owner_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"holder_cluster_id\": {\n \"eq\": 123,\n \"in\": [\n 123\n ]\n },\n \"phase_claimed_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"planned_return_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n }\n },\n \"confirmation_count\": 1\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"to_team_sid": "<string>",
"to_user_sid": "<string>",
"to_email": "<string>",
"owner_cluster_id": 123,
"holder_cluster_id": 123,
"owner_account_sid": "<string>",
"owner_channel_ref": "<string>",
"holder_account_sid": "<string>",
"holder_channel_ref": "<string>",
"holder_over_slot": true,
"planned_return_at": "<string>",
"expiry_notified_at": "<string>",
"phase_claimed_at": "<string>",
"phase_attempts": 123,
"ended_at": "<string>",
"ended_by": {
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_by": {
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"request_sid": "<string>",
"reason": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>"
},
"result": {
"closing_count": 1,
"total_matched": 1
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
},
"credits": {
"charged": 1,
"balance_after": 1
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}{
"success": false,
"error": {
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"debug_url": "<string>"
}
}Authorizations
Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of return_account_share.
Single-share mode. Mutually exclusive with filter.
Required string length:
18Pattern:
^ac_sh_Mass-target mode, resolved against the loans you RECEIVED. status is overwritten with eq active server side. Mutually exclusive with sid.
Show child attributes
Show child attributes
Blast-radius confirmation, REQUIRED with filter and ignored with sid. Must equal the active-pinned pagination.total_count of the same filter from list_received_account_shares.
Required range:
x >= 0Response
action success envelope.
Available options:
true Available options:
action kebab-case verb; matches the route segment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I