Partially update approver

Request

Security

OAuth2(Required scopes: enrichment.write)

Path

externalIdstringrequired

Previously sent externalId

Bodyapplication/merge-patch+jsonrequired

externalIdstring^\S+$required

External id of the approver that is globally unique across the provided approver data

Example:"UserID#1234"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Code of the approver in the source system (not unique across clients)

Example:"CODE1"

companyAssignmentArray of strings

List of externalCompanyIds that the approver is assigned to

Example:

[
  "DE01",
  "US01"
]

isActiveboolean

Example:true

firstNamestring

First name of the approving person

Example:"Koala"

lastNamestring

Last name of the approving person

Example:"Hinze"

emailstring, (email)

Email address of the approving person

Example:"accountant@sap.com"

phoneNumberstring

Phone number of the approving person

Example:"+491001234567891"

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

curl -i -X PATCH \
  'https://api.cloud.hypatos.ai/v2/enrichment/approvers/{externalId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "externalId": "UserID#1234",
    "externalClientId": "EXTERNAL_CLIENT_ID",
    "code": "CODE1",
    "companyAssignment": [
      "DE01",
      "US01"
    ],
    "isActive": true,
    "firstName": "Koala",
    "lastName": "Hinze",
    "email": "accountant@sap.com",
    "phoneNumber": "+491001234567891",
    "customFields": {
      "property1": "string",
      "property2": "string"
    },
    "customMetadata": {
      "someTopLevelProperty": "value1",
      "someNestedProperty": {
        "nestedProperty": "value2"
      },
      "someArrayProperty": [
        "value3",
        "value4"
      ]
    }
  }'

Responses

Successfully updated

Bodyapplication/json

externalIdstring^\S+$required

External id of the approver that is globally unique across the provided approver data

Example:"UserID#1234"

externalClientIdstring

Identifier of the client entity in the source system which can be used to separate data

Example:"EXTERNAL_CLIENT_ID"

codestring

Code of the approver in the source system (not unique across clients)

Example:"CODE1"

companyAssignmentArray of strings

List of externalCompanyIds that the approver is assigned to

Example:

[
  "DE01",
  "US01"
]

isActiveboolean

Example:true

firstNamestring

First name of the approving person

Example:"Koala"

lastNamestring

Last name of the approving person

Example:"Hinze"

emailstring, (email)

Email address of the approving person

Example:"accountant@sap.com"

phoneNumberstring

Phone number of the approving person

Example:"+491001234567891"

customFieldsobject(customFields)

List of key value pairs containing custom fields from the source system

customMetadataobject(JsonObject)

Any nested structure with metadata that source system needs to send

Example:

{
  "someTopLevelProperty": "value1",
  "someNestedProperty": {
    "nestedProperty": "value2"
  },
  "someArrayProperty": [
    "value3",
    "value4"
  ]
}

Response

{
  "externalId": "UserID#1234",
  "externalClientId": "EXTERNAL_CLIENT_ID",
  "code": "CODE1",
  "companyAssignment": [
    "DE01",
    "US01"
  ],
  "isActive": true,
  "firstName": "Koala",
  "lastName": "Hinze",
  "email": "accountant@sap.com",
  "phoneNumber": "+491001234567891",
  "customFields": {
    "property1": "string",
    "property2": "string"
  },
  "customMetadata": {
    "someTopLevelProperty": "value1",
    "someNestedProperty": { … },
    "someArrayProperty": [ … ]
  }
}