Create a mapping group
curl --request POST \
--url https://clarus-api.com/api/mapping_groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "mapping_groups",
"attributes": {
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}
}
}
'import requests
url = "https://clarus-api.com/api/mapping_groups"
payload = { "data": {
"type": "mapping_groups",
"attributes": {
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<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>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'mapping_groups',
attributes: {
name: 'Shopify products',
description: 'Maps Shopify products to Clarus products',
operation_type: 'integration_product',
integration_id: 12
}
}
})
};
fetch('https://clarus-api.com/api/mapping_groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 88,
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Mapping Groups
Create a mapping group
Create a mapping group — the container that links external entities to internal entities for a given operation type.
POST
/
api
/
mapping_groups
Create a mapping group
curl --request POST \
--url https://clarus-api.com/api/mapping_groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Clarus-Subdomain: <api-key>' \
--data '
{
"data": {
"type": "mapping_groups",
"attributes": {
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}
}
}
'import requests
url = "https://clarus-api.com/api/mapping_groups"
payload = { "data": {
"type": "mapping_groups",
"attributes": {
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}
} }
headers = {
"Authorization": "Bearer <token>",
"X-Clarus-Subdomain": "<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>',
'X-Clarus-Subdomain': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
type: 'mapping_groups',
attributes: {
name: 'Shopify products',
description: 'Maps Shopify products to Clarus products',
operation_type: 'integration_product',
integration_id: 12
}
}
})
};
fetch('https://clarus-api.com/api/mapping_groups', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"id": 88,
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}{
"error": "<string>"
}{
"errors": [
{
"code": 123,
"symbol": "<string>",
"details": "<string>",
"source": "<string>",
"context": {}
}
]
}Request Structure
{
"data": {
"type": "mapping_groups",
"attributes": {
"name": "Shopify products",
"description": "Maps Shopify products to Clarus products",
"operation_type": "integration_product",
"integration_id": 12
}
}
}
Key Fields
| Field | Required | Description |
|---|---|---|
name | Yes | Group name (max 50) |
description | Yes | Description (max 150) |
operation_type | Yes | Purpose of the group (see enum) |
integration_id | No | Owning integration |
POST /api/mapping_groups/{mapping_group_id}/mapping_group_fields.Authorizations
OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.
The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.
Body
application/json
Show child attributes
Show child attributes
Response
Created successfully
Created record
⌘I

