Update User

PATCH

/users/{object_id}

Users

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Body Params application/vnd.api+json

data

object (User)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

User

Example:

User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "User",
        "attributes": {
            "name": "string",
            "emailAddress": "string",
            "externalId": "string",
            "profilePicture": {
                "__type": "File",
                "name": "string",
                "url": "string"
            },
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "notificationConfig": {},
            "marketingEmailsConsent": "string"
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "userAttributes": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserAttribute"
                    }
                ]
            },
            "userGroups": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                ]
            }
        }
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.synap.ac/v3/users/' \
--header 'Content-Type: application/vnd.api+json' \
--data-raw '{
    "data": {
        "id": "FID001",
        "type": "User",
        "attributes": {
            "name": "string",
            "emailAddress": "string",
            "externalId": "string",
            "profilePicture": {
                "__type": "File",
                "name": "string",
                "url": "string"
            },
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "notificationConfig": {},
            "marketingEmailsConsent": "string"
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "userAttributes": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserAttribute"
                    }
                ]
            },
            "userGroups": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                ]
            }
        }
    }
}'

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (User)

optional

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

User

Example:

User

attributes

object

optional

relationships

object

optional

included

array[object (GenericResource) {4}]

optional

string

optional

The primary key for each resource.

Example:

FID001

type

string

optional

Identifies the Resource.

Example:

_User

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "User",
        "attributes": {
            "createdAt": "string",
            "name": "string",
            "emailAddress": "string",
            "externalId": "string",
            "profilePicture": {
                "__type": "File",
                "name": "string",
                "url": "string"
            },
            "preferences": {},
            "attr": {},
            "timeZone": "string",
            "notificationConfig": {},
            "marketingEmailsConsent": "string",
            "lastSeen": "string",
            "emailVerified": true,
            "authData": {},
            "firstName": "string",
            "lastName": "string",
            "userGroupsMetadata": {
                "property1": {
                    "dateJoined": "2019-08-24T14:15:22Z"
                },
                "property2": {
                    "dateJoined": "2019-08-24T14:15:22Z"
                }
            }
        },
        "relationships": {
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            },
            "userAttributes": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserAttribute"
                    }
                ]
            },
            "userGroups": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "UserGroup"
                    }
                ]
            }
        }
    },
    "included": [
        {
            "id": "FID001",
            "type": "_User",
            "attributes": {},
            "relationships": {
                "property1": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                },
                "property2": {
                    "data": {
                        "id": "FID001",
                        "type": "_User"
                    },
                    "links": {
                        "self": "string",
                        "related": "string"
                    },
                    "meta": {}
                }
            }
        }
    ]
}

🟢204No Content

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

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

Get User

Delete User