Create AttributeConfig

POST

/attribute-configs

Content Metadata

Request

Body Params application/vnd.api+json

data

object

required

type

enum<string>

required

Identifies the Resource.

Allowed value:

AttributeConfig

Example:

AttributeConfig

attributes

object

required

relationships

object

optional

Example

{
    "data": {
        "type": "AttributeConfig",
        "attributes": {
            "customId": "string",
            "target": "User",
            "type": "boolean",
            "label": "string",
            "sublabel": "string",
            "description": "string",
            "options": [
                {
                    "value": "string",
                    "label": "string"
                }
            ],
            "labelQuestion": "string",
            "registration": {
                "collect": true
            },
            "required": true,
            "editPermission": 0,
            "viewPermission": 0,
            "settings": {
                "link": {
                    "display": {
                        "asButton": true
                    },
                    "authenticated": true,
                    "clickBehavior": "newWindow"
                }
            }
        },
        "relationships": {}
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.synap.ac/v3/attribute-configs' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "type": "AttributeConfig",
        "attributes": {
            "customId": "string",
            "target": "User",
            "type": "boolean",
            "label": "string",
            "sublabel": "string",
            "description": "string",
            "options": [
                {
                    "value": "string",
                    "label": "string"
                }
            ],
            "labelQuestion": "string",
            "registration": {
                "collect": true
            },
            "required": true,
            "editPermission": 0,
            "viewPermission": 0,
            "settings": {
                "link": {
                    "display": {
                        "asButton": true
                    },
                    "authenticated": true,
                    "clickBehavior": "newWindow"
                }
            }
        },
        "relationships": {}
    }
}'

Responses

🟢201Created

application/vnd.api+json

Created

Body

data

object (AttributeConfig)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AttributeConfig

Example:

AttributeConfig

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AttributeConfig",
        "attributes": {
            "customId": "string",
            "target": "User",
            "type": "boolean",
            "label": "string",
            "sublabel": "string",
            "description": "string",
            "options": [
                {
                    "value": "string",
                    "label": "string"
                }
            ],
            "labelQuestion": "string",
            "registration": {
                "collect": true
            },
            "required": true,
            "editPermission": 0,
            "viewPermission": 0,
            "settings": {
                "link": {
                    "display": {
                        "asButton": true
                    },
                    "authenticated": true,
                    "clickBehavior": "newWindow"
                }
            },
            "inUse": true
        },
        "relationships": {}
    }
}

🟢202Accepted

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409409

Modified at 2025-07-08 10:51:21

Delete Highlight

List AttributeConfigs