Skip to content

Update member field

PATCH /member-attribute/{id}

Changes the label, description, source or SCIM attribute. `key` and `type` cannot change (400 `attribute_immutable_field`): tools and stored values depend on them. Switching to `manual` drops `scim_path`. Requires `member:manage`.

Path Parameters

idstring
required·

Member field id (mad_…).

Request Body

descriptionstring,null
labelstring
scim_pathstring,null
Possible values:
employeeNumberdepartmentcostCenterdivisionorganizationmanager.valuetitlenull
sourcestring
Possible values:
manualscim

Response Body

can_manageboolean

You hold member:manage: you may edit or delete this field.

can_set_valuesboolean

can_manage and the field is manual. False for a SCIM field even for an admin.

created_atstring · date-time
descriptionstring,null
idstring

Member field id (mad_…).

keystring

What placeholders name: {{caller.attributes.<key>}}. Immutable.

labelstring
member_countinteger,null

How many current members the organization has (the set GET /member lists). Null unless you hold member:manage.

scim_pathstring,null

For source: scim: the SCIM User attribute it mirrors (enterprise extension, or core title).

Possible values:
employeeNumberdepartmentcostCenterdivisionorganizationmanager.valuetitlenull
sourcestring

manual: an admin types the values. scim: your identity provider fills them; nobody can type one.

Possible values:
manualscim
typestring

Immutable.

Possible values:
textnumberbooleantext_list
updated_atstring · date-time
value_countinteger,null

How many current members hold a value for this field. Null unless you hold member:manage. The members without one: GET /member?attribute_missing=<key>.

curl -X PATCH 'https://api.elaichi.ai/member-attribute/<id>' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"label":"your_label","source":"manual","scim_path":"employeeNumber"}'
const body = {
  "label": "your_label",
  "source": "manual",
  "scim_path": "employeeNumber"
};

const response = await fetch('https://api.elaichi.ai/member-attribute/<id>', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/member-attribute/<id>"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}
payload = {
    "label": "your_label",
    "source": "manual",
    "scim_path": "employeeNumber"
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())