Create an attribute

Required membership role: org admin. PBAC permission: organization.attributes.create. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control

POST /v2/organizations/{orgId}/attributes

Create an attribute

cURL

curl --request POST \
  --url https://api.cal.com/v2/organizations/{orgId}/attributes \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "options": [
    {
      "value": "<string>",
      "slug": "<string>"
    }
  ],
  "enabled": true
}
'

import requests

url = "https://api.cal.com/v2/organizations/{orgId}/attributes"

payload = {
    "name": "<string>",
    "slug": "<string>",
    "options": [
        {
            "value": "<string>",
            "slug": "<string>"
        }
    ],
    "enabled": True
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    slug: '<string>',
    options: [{value: '<string>', slug: '<string>'}],
    enabled: true
  })
};

fetch('https://api.cal.com/v2/organizations/{orgId}/attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cal.com/v2/organizations/{orgId}/attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'slug' => '<string>',
    'options' => [
        [
                'value' => '<string>',
                'slug' => '<string>'
        ]
    ],
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cal.com/v2/organizations/{orgId}/attributes"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"options\": [\n    {\n      \"value\": \"<string>\",\n      \"slug\": \"<string>\"\n    }\n  ],\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/organizations/{orgId}/attributes")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"options\": [\n    {\n      \"value\": \"<string>\",\n      \"slug\": \"<string>\"\n    }\n  ],\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/organizations/{orgId}/attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"options\": [\n    {\n      \"value\": \"<string>\",\n      \"slug\": \"<string>\"\n    }\n  ],\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

201

{
  "status": "success",
  "data": {
    "id": "attr_123",
    "teamId": 1,
    "name": "Attribute Name",
    "slug": "attribute-name",
    "enabled": true,
    "usersCanEditRelation": true
  }
}

Headers

Authorization · string · required

value must be Bearer <token> where <token> is api key prefixed with cal_

Path Parameters

orgId · number · required

Body

application/json

name · string · required

slug · string · required

type · enum<string> · required

Available options: TEXT, NUMBER, SINGLE_SELECT, MULTI_SELECT, USER_RELATIONSHIP

options · object[] · required

Show child attributes

enabled · boolean

Response

201 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes