Customer groups
Update customer group
Updates the group. When net_terms is included in the request, the new value
is also propagated to every member customer’s net_terms (set to null on the
members when cleared). Send an empty string or null to clear and inherit from
the merchant default.
PUT
/
customer_groups
/
{uuid}
Update customer group
curl --request PUT \
--url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-App-Id: <api-key>' \
--data '
{
"customer_group": {
"company_name": "<string>"
}
}
'const options = {
method: 'PUT',
headers: {
'X-App-Id': '<api-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({customer_group: {company_name: '<string>'}})
};
fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}"
payload = { "customer_group": { "company_name": "<string>" } }
headers = {
"X-App-Id": "<api-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_group\": {\n \"company_name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"customer_group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"net_terms": 0,
"net_terms_label": "<string>",
"number_of_customers": 123,
"total_open_balance_amount": 123,
"statement_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>"
}
]
}
}Authorizations
App ID for authentication
API Key for authentication
Path Parameters
Body
application/json
Show child attributes
Show child attributes
Response
Customer group updated
Group fields with inline customers array. Returned by show, create, and update.
Show child attributes
Show child attributes
⌘I
Update customer group
curl --request PUT \
--url https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid} \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--header 'X-App-Id: <api-key>' \
--data '
{
"customer_group": {
"company_name": "<string>"
}
}
'const options = {
method: 'PUT',
headers: {
'X-App-Id': '<api-key>',
'X-Api-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({customer_group: {company_name: '<string>'}})
};
fetch('https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}"
payload = { "customer_group": { "company_name": "<string>" } }
headers = {
"X-App-Id": "<api-key>",
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)require 'uri'
require 'net/http'
url = URI("https://api.staging.streamlinedpayments.com/api/v1/customer_groups/{uuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer_group\": {\n \"company_name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"customer_group": {
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>",
"net_terms": 0,
"net_terms_label": "<string>",
"number_of_customers": 123,
"total_open_balance_amount": 123,
"statement_url": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customers": [
{
"uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_name": "<string>"
}
]
}
}