Patch clients
curl --request PATCH \
--url https://api.yume.cloud/v1/crm/clients/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ticks": [
123
],
"legal": {
"bin": "<string>",
"address": "<string>",
"director": "<string>",
"iban": "<string>",
"bik": "<string>",
"bank": "<string>"
},
"individual": {
"iin": "<string>",
"address": "<string>",
"document_number": "<string>",
"issuer_manual": "<string>",
"issue_date": "2023-12-25",
"issue_date_end": "2023-12-25",
"birth_date": "2023-12-25"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"deposit": "<string>",
"signed": true,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}
'import requests
url = "https://api.yume.cloud/v1/crm/clients/{id}/"
payload = {
"ticks": [123],
"legal": {
"bin": "<string>",
"address": "<string>",
"director": "<string>",
"iban": "<string>",
"bik": "<string>",
"bank": "<string>"
},
"individual": {
"iin": "<string>",
"address": "<string>",
"document_number": "<string>",
"issuer_manual": "<string>",
"issue_date": "2023-12-25",
"issue_date_end": "2023-12-25",
"birth_date": "2023-12-25"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"deposit": "<string>",
"signed": True,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}
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({
ticks: [123],
legal: {
bin: '<string>',
address: '<string>',
director: '<string>',
iban: '<string>',
bik: '<string>',
bank: '<string>'
},
individual: {
iin: '<string>',
address: '<string>',
document_number: '<string>',
issuer_manual: '<string>',
issue_date: '2023-12-25',
issue_date_end: '2023-12-25',
birth_date: '2023-12-25'
},
created_at: '2023-11-07T05:31:56Z',
name: '<string>',
comment: '<string>',
avatar: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
deposit: '<string>',
signed: true,
sign_date: '2023-12-25',
sign_expires: '2023-12-25',
extra: '<unknown>',
tenant: 123,
legal_passport: 123,
individual_passport: 123,
attraction: 123,
discount: 123,
user: 123
})
};
fetch('https://api.yume.cloud/v1/crm/clients/{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://api.yume.cloud/v1/crm/clients/{id}/",
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([
'ticks' => [
123
],
'legal' => [
'bin' => '<string>',
'address' => '<string>',
'director' => '<string>',
'iban' => '<string>',
'bik' => '<string>',
'bank' => '<string>'
],
'individual' => [
'iin' => '<string>',
'address' => '<string>',
'document_number' => '<string>',
'issuer_manual' => '<string>',
'issue_date' => '2023-12-25',
'issue_date_end' => '2023-12-25',
'birth_date' => '2023-12-25'
],
'created_at' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'comment' => '<string>',
'avatar' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'deposit' => '<string>',
'signed' => true,
'sign_date' => '2023-12-25',
'sign_expires' => '2023-12-25',
'extra' => '<unknown>',
'tenant' => 123,
'legal_passport' => 123,
'individual_passport' => 123,
'attraction' => 123,
'discount' => 123,
'user' => 123
]),
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://api.yume.cloud/v1/crm/clients/{id}/"
payload := strings.NewReader("{\n \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\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://api.yume.cloud/v1/crm/clients/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yume.cloud/v1/crm/clients/{id}/")
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 \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"bonus": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"amount": "<string>"
},
"orders_count": 123,
"orders_amount": "<string>",
"orders_paid_amount": "<string>",
"orders_debt_amount": "<string>",
"overdue_rentals_amount": "<string>",
"transfer_count": 123,
"transfer_amount": "<string>",
"last_rent_date": "2023-11-07T05:31:56Z",
"total_time": "<string>",
"iin": "<string>",
"bin": "<string>",
"balance": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"agreement_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"type": 0,
"legal_type": 0,
"gender": 0,
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"deposit": "<string>",
"signed": true,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}clients
Patch clients
PATCH
/
v1
/
crm
/
clients
/
{id}
/
Patch clients
curl --request PATCH \
--url https://api.yume.cloud/v1/crm/clients/{id}/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ticks": [
123
],
"legal": {
"bin": "<string>",
"address": "<string>",
"director": "<string>",
"iban": "<string>",
"bik": "<string>",
"bank": "<string>"
},
"individual": {
"iin": "<string>",
"address": "<string>",
"document_number": "<string>",
"issuer_manual": "<string>",
"issue_date": "2023-12-25",
"issue_date_end": "2023-12-25",
"birth_date": "2023-12-25"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"deposit": "<string>",
"signed": true,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}
'import requests
url = "https://api.yume.cloud/v1/crm/clients/{id}/"
payload = {
"ticks": [123],
"legal": {
"bin": "<string>",
"address": "<string>",
"director": "<string>",
"iban": "<string>",
"bik": "<string>",
"bank": "<string>"
},
"individual": {
"iin": "<string>",
"address": "<string>",
"document_number": "<string>",
"issuer_manual": "<string>",
"issue_date": "2023-12-25",
"issue_date_end": "2023-12-25",
"birth_date": "2023-12-25"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"deposit": "<string>",
"signed": True,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}
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({
ticks: [123],
legal: {
bin: '<string>',
address: '<string>',
director: '<string>',
iban: '<string>',
bik: '<string>',
bank: '<string>'
},
individual: {
iin: '<string>',
address: '<string>',
document_number: '<string>',
issuer_manual: '<string>',
issue_date: '2023-12-25',
issue_date_end: '2023-12-25',
birth_date: '2023-12-25'
},
created_at: '2023-11-07T05:31:56Z',
name: '<string>',
comment: '<string>',
avatar: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
deposit: '<string>',
signed: true,
sign_date: '2023-12-25',
sign_expires: '2023-12-25',
extra: '<unknown>',
tenant: 123,
legal_passport: 123,
individual_passport: 123,
attraction: 123,
discount: 123,
user: 123
})
};
fetch('https://api.yume.cloud/v1/crm/clients/{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://api.yume.cloud/v1/crm/clients/{id}/",
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([
'ticks' => [
123
],
'legal' => [
'bin' => '<string>',
'address' => '<string>',
'director' => '<string>',
'iban' => '<string>',
'bik' => '<string>',
'bank' => '<string>'
],
'individual' => [
'iin' => '<string>',
'address' => '<string>',
'document_number' => '<string>',
'issuer_manual' => '<string>',
'issue_date' => '2023-12-25',
'issue_date_end' => '2023-12-25',
'birth_date' => '2023-12-25'
],
'created_at' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'comment' => '<string>',
'avatar' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'deposit' => '<string>',
'signed' => true,
'sign_date' => '2023-12-25',
'sign_expires' => '2023-12-25',
'extra' => '<unknown>',
'tenant' => 123,
'legal_passport' => 123,
'individual_passport' => 123,
'attraction' => 123,
'discount' => 123,
'user' => 123
]),
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://api.yume.cloud/v1/crm/clients/{id}/"
payload := strings.NewReader("{\n \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\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://api.yume.cloud/v1/crm/clients/{id}/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.yume.cloud/v1/crm/clients/{id}/")
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 \"ticks\": [\n 123\n ],\n \"legal\": {\n \"bin\": \"<string>\",\n \"address\": \"<string>\",\n \"director\": \"<string>\",\n \"iban\": \"<string>\",\n \"bik\": \"<string>\",\n \"bank\": \"<string>\"\n },\n \"individual\": {\n \"iin\": \"<string>\",\n \"address\": \"<string>\",\n \"document_number\": \"<string>\",\n \"issuer_manual\": \"<string>\",\n \"issue_date\": \"2023-12-25\",\n \"issue_date_end\": \"2023-12-25\",\n \"birth_date\": \"2023-12-25\"\n },\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"comment\": \"<string>\",\n \"avatar\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"deposit\": \"<string>\",\n \"signed\": true,\n \"sign_date\": \"2023-12-25\",\n \"sign_expires\": \"2023-12-25\",\n \"extra\": \"<unknown>\",\n \"tenant\": 123,\n \"legal_passport\": 123,\n \"individual_passport\": 123,\n \"attraction\": 123,\n \"discount\": 123,\n \"user\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"bonus": {
"id": 123,
"created_at": "2023-11-07T05:31:56Z",
"amount": "<string>"
},
"orders_count": 123,
"orders_amount": "<string>",
"orders_paid_amount": "<string>",
"orders_debt_amount": "<string>",
"overdue_rentals_amount": "<string>",
"transfer_count": 123,
"transfer_amount": "<string>",
"last_rent_date": "2023-11-07T05:31:56Z",
"total_time": "<string>",
"iin": "<string>",
"bin": "<string>",
"balance": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"phone": "<string>",
"agreement_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"type": 0,
"legal_type": 0,
"gender": 0,
"comment": "<string>",
"avatar": "<string>",
"email": "jsmith@example.com",
"deposit": "<string>",
"signed": true,
"sign_date": "2023-12-25",
"sign_expires": "2023-12-25",
"extra": "<unknown>",
"tenant": 123,
"legal_passport": 123,
"individual_passport": 123,
"attraction": 123,
"discount": 123,
"user": 123
}Авторизации
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Заголовки
Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.
Параметры пути
Тело
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
5120- Физ. лицо1- Юр. лицо
Доступные опции:
0, 1 Требуемый диапазон:
0 <= x <= 21474836470- ИП1- ТОО2- АО3- ПК
Доступные опции:
0, 1, 2, 3 Требуемый диапазон:
0 <= x <= 21474836470- мужской1- женский
Доступные опции:
0, 1 Требуемый диапазон:
0 <= x <= 2147483647Maximum string length:
512Maximum string length:
254Maximum string length:
32Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Ответ
200 - application/json
Show child attributes
Show child attributes
Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$Maximum string length:
512Maximum string length:
320- Физ. лицо1- Юр. лицо
Доступные опции:
0, 1 Требуемый диапазон:
0 <= x <= 21474836470- ИП1- ТОО2- АО3- ПК
Доступные опции:
0, 1, 2, 3 Требуемый диапазон:
0 <= x <= 21474836470- мужской1- женский
Доступные опции:
0, 1 Требуемый диапазон:
0 <= x <= 2147483647Maximum string length:
512Maximum string length:
254Pattern:
^-?\d{0,14}(?:\.\d{0,2})?$