Edit Custom Field

patch https://stage.samdock.app/api/contacts/custom-fields/{entity}/{id}

Based on key value pair, this endpoint is used to edit the custom field as a whole.

Path Params

string

required

entity

string

required

Body Params

_id

string

required

Defaults to e52db3a2-fdb9-4810-9ef2-03143ea14430

the id of the custom field

_tenantID

string

required

Defaults to 1

the id of the tenant

name

string

required

Defaults to John

the name of the custom field

key

string

required

Defaults to 123-321

the key of the custom field

description

string

Defaults to 1

the description of the custom field

type

string

required

Defaults to 2

the type of the custom field

selectListOptions

array of objects

the options array of the custom selection/multiselection field

selectListOptions

status

string

the status of the custom field

createdAt

number

required

when custom field was created

createdBy

string

required

id of User who created custom field

updatedAt

number

when custom field was updated

updatedBy

string

id of User who updated custom field

Responses

401

Unauthorized error

500

Internal Server Error

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
14
1
curl --request PATCH \
2
     --url https://stage.samdock.app/api/contacts/custom-fields/person/id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "_id": "e52db3a2-fdb9-4810-9ef2-03143ea14430",
8
  "_tenantID": 1,
9
  "name": "John",
10
  "key": "123-321",
11
  "description": 1,
12
  "type": 2
13
}
14
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The custom field editing event has successfully been triggered