Jump to

• Request
• Response

Set a new property for the specified user.

post

/social/api/v1/people/{peopleID}/properties

Request

Supported Media Types

• application/json

Path Parameters

• peopleID: integer(int64)
  The people ID. The object's unique identifier from a long integer representation.

Body ()

The request body defines the details of the request.

Root Schema : XV1PeoplePropertyCreateInfo

Type: object

V1 People Property Create Information.

Show Source

• name(optional): string
  The property name. Required.
• value(optional): string
  The property value.

{
    "description":"V1 People Property Create Information.",
    "properties":{
        "name":{
            "description":"The property name. Required.",
            "type":"string"
        },
        "value":{
            "description":"The property value.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1PeoplePropertyInfo

Type: object

V1 People Property Information DTO.

Show Source

• name(optional): string
  The property name.
• value(optional): string(uuid)
  The property value.

{
    "description":"V1 People Property Information DTO.",
    "properties":{
        "name":{
            "description":"The property name.",
            "type":"string"
        },
        "value":{
            "description":"The property value.",
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top