Open API v2 / CRM & Orders / CRM Advanced Crm RestrictionGroupLayout
CRM Advanced Crm RestrictionGroupLayout
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of advanced crm groups by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idstring · nullable
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the advanced crm group.
Aliasstring · nullable
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Propertiesarray of objects
Describes the configuration of specific fields (attributes) in your CRM group. Each object in the array is an instruction to the CMS on how to display and validate the field.
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring
Name of the crm field.
Typeenum
Data type. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
Determines whether a field is required. Available for: [ DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Upload ] by default: false.
Optionsarray of strings
An array of strings that indicates which objects in CRM this group belongs to. Available for: [ CheckboxList, DropdownList, ListboxList, RadioList ]
curl "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": "string",
"Name": "Example",
"Alias": "string",
"ApplyToTypes": [
"Contacts"
],
"Properties": [
{
"Id": 1,
"Name": "Example",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}
],
"TotalItemsCount": 0
}Creates a new advanced crm group
Body parameters
Namestringrequired
Name of the advanced crm group.
Aliasstringrequired
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Response
Idstring · nullable
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the advanced crm group.
Aliasstring · nullable
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Propertiesarray of objects
Describes the configuration of specific fields (attributes) in your CRM group. Each object in the array is an instruction to the CMS on how to display and validate the field.
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring
Name of the crm field.
Typeenum
Data type. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
Determines whether a field is required. Available for: [ DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Upload ] by default: false.
Optionsarray of strings
An array of strings that indicates which objects in CRM this group belongs to. Available for: [ CheckboxList, DropdownList, ListboxList, RadioList ]
curl -X POST "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","Alias":"string","ApplyToTypes":["Contacts"]}'
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "Alias": "string", "ApplyToTypes": [ "Contacts" ] }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "Alias": "string", "ApplyToTypes": ["Contacts"] } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'Alias' => 'string', 'ApplyToTypes' => ['Contacts'] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"Alias\":\"string\",\"ApplyToTypes\":[\"Contacts\"]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": "string",
"Name": "Example",
"Alias": "string",
"ApplyToTypes": [
"Contacts"
],
"Properties": [
{
"Id": 1,
"Name": "Example",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}Retrieves a single advanced crm group
Parameters
idinteger · pathrequired
Advanced crm group id.
Response
Idstring · nullable
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the advanced crm group.
Aliasstring · nullable
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Propertiesarray of objects
Describes the configuration of specific fields (attributes) in your CRM group. Each object in the array is an instruction to the CMS on how to display and validate the field.
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring
Name of the crm field.
Typeenum
Data type. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
Determines whether a field is required. Available for: [ DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Upload ] by default: false.
Optionsarray of strings
An array of strings that indicates which objects in CRM this group belongs to. Available for: [ CheckboxList, DropdownList, ListboxList, RadioList ]
curl "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": "string",
"Name": "Example",
"Alias": "string",
"ApplyToTypes": [
"Contacts"
],
"Properties": [
{
"Id": 1,
"Name": "Example",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}Updates an existing advanced crm group
Parameters
idinteger · pathrequired
Existent advanced crm group id.
Body parameters
Propertiesarray of objects
The fields (attributes) that make up this CRM group. Each entry defines how a field is displayed and validated.
Idinteger
Unique identifier assigned by the platform.
Namestringrequired
Name of the crm field.
Typeenum
The input type of the CRM field, which controls how it is rendered and validated. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
Whether the field must be filled in before the record can be saved.
Optionsarray of strings
The list of choices offered by the field. Applies only to selection types such as CheckboxList, DropdownList, ListboxList, and RadioList.
Namestringrequired
Name of the advanced crm group.
Aliasstringrequired
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Response
Idstring · nullable
Unique identifier. Technical record number in the database. Read-only.
Namestring · nullable
Name of the advanced crm group.
Aliasstring · nullable
The Liquid reference that can be used to access this Properties value.
ApplyToTypesarray of enums
An array of strings that indicates which objects in CRM this group belongs to.
Propertiesarray of objects
Describes the configuration of specific fields (attributes) in your CRM group. Each object in the array is an instruction to the CMS on how to display and validate the field.
Idinteger
Unique identifier. Technical record number in the database. Read-only.
Namestring
Name of the crm field.
Typeenum
Data type. Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
Determines whether a field is required. Available for: [ DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Upload ] by default: false.
Optionsarray of strings
An array of strings that indicates which objects in CRM this group belongs to. Available for: [ CheckboxList, DropdownList, ListboxList, RadioList ]
curl -X PUT "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Properties":[{"Id":1,"Name":"Example","Type":"DateTime","IsMandatory":false,"Options":["string"]}],"Name":"Example","Alias":"string","ApplyToTypes":["Contacts"]}'
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Properties": [ { "Id": 1, "Name": "Example", "Type": "DateTime", "IsMandatory": false, "Options": [ "string" ] } ], "Name": "Example", "Alias": "string", "ApplyToTypes": [ "Contacts" ] }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", headers={"Authorization": "Bearer <token>"}, json={ "Properties": [{ "Id": 1, "Name": "Example", "Type": "DateTime", "IsMandatory": False, "Options": ["string"] }], "Name": "Example", "Alias": "string", "ApplyToTypes": ["Contacts"] } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Properties' => [[ 'Id' => 1, 'Name' => 'Example', 'Type' => 'DateTime', 'IsMandatory' => false, 'Options' => ['string'] ]], 'Name' => 'Example', 'Alias' => 'string', 'ApplyToTypes' => ['Contacts'] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Properties\":[{\"Id\":1,\"Name\":\"Example\",\"Type\":\"DateTime\",\"IsMandatory\":false,\"Options\":[\"string\"]}],\"Name\":\"Example\",\"Alias\":\"string\",\"ApplyToTypes\":[\"Contacts\"]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": "string",
"Name": "Example",
"Alias": "string",
"ApplyToTypes": [
"Contacts"
],
"Properties": [
{
"Id": 1,
"Name": "Example",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}Deletes an existing advanced crm group
Parameters
idinteger · pathrequired
Existent advanced crm group id.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Retrieves a list of advanced crm group field types
Response
curl "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/field-types" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/field-types", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/field-types", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/field-types', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/field-types"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[ "string" ]
Retrieves a list of advanced crm group types
Response
DisplayNamestring · nullable
Display name of the advanced crm group type, shown to users.
Valuestring · nullable
The technical key of the object type this group can be applied to (for example Contacts or Order).
curl "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/types" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/types", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/types", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/types', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/advanced-crm-groups/types"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"DisplayName": "Example",
"Value": "string"
}
]