Skip to main content
POST
/
api
/
mapping_groups
/
{mapping_group_id}
/
mapping_group_fields
Create a mapping group field
curl --request POST \
  --url https://clarus-api.com/api/mapping_groups/{mapping_group_id}/mapping_group_fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "mapping_group_fields",
    "attributes": {
      "field_name": "sku",
      "field_type": "string"
    }
  }
}
'
{
  "id": 210,
  "field_name": "sku",
  "field_type": "string",
  "mapping_group_id": 88
}

​
Request Structure

{
  "data": {
    "type": "mapping_group_fields",
    "attributes": {
      "field_name": "sku",
      "field_type": "string"
    }
  }
}
FieldRequiredDescription
field_nameYesField code (^[a-zA-Z0-9_]*$, max 50)
field_typeYesCurrently only string

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
mapping_group_id
integer
required

The mapping group to add the field to

Body

application/json
​
data
object
required

Response

Created successfully

Created record