Relations

Update Relations (partial)

PATCH
/relations/{relationId}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

relationId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/relations/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "relationId": "string",  "childUserId": "string",  "parentUserId": "string",  "childUser": {    "userId": "string",    "profileId": "string",    "profile": {      "profileId": "string",      "firstName": "string",      "lastName": "string",      "middleName": "string",      "countryNumericCode": "string",      "enabled": true,      "contacts": [        {          "contactId": "string",          "key": "email",          "value": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z",      "uuid": "string"    },    "groupId": "string",    "group": {      "groupId": "string",      "name": "string",      "formula": "string",      "levels": [        {          "levelId": "string",          "groupId": "string",          "level": 0,          "formulaValue": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "tiers": [        {          "tierId": "string",          "groupId": "string",          "name": "string",          "ratio": "string",          "users": 0,          "volume": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z",      "uuid": "string"    },    "enabled": true,    "master": true,    "masterMaxLevel": 0,    "masterRatio": "string",    "ratio": "string",    "tag": "string",    "createTime": "2019-08-24T14:15:22Z",    "updateTime": "2019-08-24T14:15:22Z",    "uuid": "string"  },  "parentUser": {    "userId": "string",    "profileId": "string",    "profile": {      "profileId": "string",      "firstName": "string",      "lastName": "string",      "middleName": "string",      "countryNumericCode": "string",      "enabled": true,      "contacts": [        {          "contactId": "string",          "key": "email",          "value": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z",      "uuid": "string"    },    "groupId": "string",    "group": {      "groupId": "string",      "name": "string",      "formula": "string",      "levels": [        {          "levelId": "string",          "groupId": "string",          "level": 0,          "formulaValue": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "tiers": [        {          "tierId": "string",          "groupId": "string",          "name": "string",          "ratio": "string",          "users": 0,          "volume": "string",          "createTime": "2019-08-24T14:15:22Z",          "updateTime": "2019-08-24T14:15:22Z",          "uuid": "string"        }      ],      "createTime": "2019-08-24T14:15:22Z",      "updateTime": "2019-08-24T14:15:22Z",      "uuid": "string"    },    "enabled": true,    "master": true,    "masterMaxLevel": 0,    "masterRatio": "string",    "ratio": "string",    "tag": "string",    "createTime": "2019-08-24T14:15:22Z",    "updateTime": "2019-08-24T14:15:22Z",    "uuid": "string"  },  "createTime": "2019-08-24T14:15:22Z",  "updateTime": "2019-08-24T14:15:22Z",  "uuid": "string"}
{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}
{  "message": "string",  "errors": {    "property1": [      "string"    ],    "property2": [      "string"    ]  }}