arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

updateSubject

This method is to update an existing subject.

This method was added in Cortex 2.1

hashtag
Parameters

Name

Type

A subject is identified by his/her name, so you must provide the name of the subject you want to update. Then you can set one or more of the not required fields to update their value.

hashtag
Result

The result is a representing the updated subject.

hashtag
Examples

Update the date of birth of a subject.

Required

Description

cortexToken

string

yes

A token returned by .

subjectName

string

yes

The name of the subject.

dateOfBirth

string

no

The date of birth of the subject. The format must be "YYYY-MM-DD", e.g. "1980-12-25".

sex

string

no

Must be "M", "F" or "U". These letters stands for male, female and unknown respectively.

countryCode

string

no

The of the country the subject lives in.

state

string

no

The state the subject lives in.

city

string

no

The city the subject lives in.

attributes

array of objects

no

A list of demographic attribute objects. See .

subject object
{
    "id": 1,
    "jsonrpc": "2.0",
    "method": "updateSubject",
    "params": {
        "cortexToken": "xxx",
        "subjectName": "Bob Smith",
        "dateOfBirth": "1978-11-21"
    }
}
{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "attributes": [],
        "city": "",
        "countryCode": "",
        "countryName": "",
        "dateOfBirth": "1978-11-21",
        "experimentsCount": 0,
        "modifiedDatetime": "2019-07-01T11:49:50.332+07:00",
        "sex": "U",
        "state": "",
        "subjectName": "Bob Smith"
    }
}
authorize
Alpha-2 ISO codearrow-up-right
Subject object