Upsert

POST /okapicrm.v1.OkapiCRMService/UpsertRecord

Try it

cURL

cURL

curl --request POST \
  --url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/UpsertRecord \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "matchOn": "<string>",
  "record": {
    "archived": true,
    "createTime": {},
    "createdBy": {
      "apiKeyId": "<string>",
      "builtinIntegration": [
        "BUILTIN_INTEGRATION_UNSPECIFIED",
        "BUILTIN_INTEGRATION_GMAIL_V1",
        "BUILTIN_INTEGRATION_OUTLOOK_V1",
        "BUILTIN_INTEGRATION_LINKEDIN_V1"
      ],
      "userId": "<string>"
    },
    "deleted": true,
    "fields": {},
    "formulaErrors": {},
    "id": "<string>",
    "objectApiName": "<string>",
    "objectId": "<string>"
  },
  "updateFields": [
    "<string>"
  ]
}
'

200

{
  "archived": true,
  "createTime": {},
  "createdBy": {
    "apiKeyId": "<string>",
    "builtinIntegration": [
      "BUILTIN_INTEGRATION_UNSPECIFIED",
      "BUILTIN_INTEGRATION_GMAIL_V1",
      "BUILTIN_INTEGRATION_OUTLOOK_V1",
      "BUILTIN_INTEGRATION_LINKEDIN_V1"
    ],
    "userId": "<string>"
  },
  "deleted": true,
  "fields": {},
  "formulaErrors": {},
  "id": "<string>",
  "objectApiName": "<string>",
  "objectId": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

matchOn · string

record · record · object

Show child attributes

record. archived · boolean

record. createTime · create_time · object

record. createdBy · created_by · object

Show child attributes

record.createdBy. apiKeyId · string

record.createdBy. builtinIntegration · enum<string>

Available options: BUILTIN_INTEGRATION_UNSPECIFIEDBUILTIN_INTEGRATION_GMAIL_V1BUILTIN_INTEGRATION_OUTLOOK_V1BUILTIN_INTEGRATION_LINKEDIN_V1

record.createdBy. userId · string

record. deleted · boolean

record. fields · fields · object

record. formulaErrors · formula_errors · object

record. id · string

record. objectApiName · string

record. objectId · string

updateFields · string[]

Response

200

application/json

archived · boolean

createTime · create_time · object

createdBy · created_by · object

Show child attributes

createdBy. apiKeyId · string

createdBy. builtinIntegration · enum<string>

Available options: BUILTIN_INTEGRATION_UNSPECIFIEDBUILTIN_INTEGRATION_GMAIL_V1BUILTIN_INTEGRATION_OUTLOOK_V1BUILTIN_INTEGRATION_LINKEDIN_V1

createdBy. userId · string

deleted · boolean

fields · fields · object

formulaErrors · formula_errors · object

id · string

objectApiName · string

objectId · string