Update Customer

PUT 
/api/contacts/customer/:id

Update Customer

Request

Path Parameters

id integerrequired

Header Parameters

X-Company-Slug stringrequired

application/json

Body

name string
surname string
type ContactTypeEnum (string)

Possible values: [vendor, customer]

email email
phone phone
gender ContactGenderEnum (string)

Possible values: [male, female, other]

birthdate date
address string
custom_fields object

permissions

object

gdpr booleanrequired

sms boolean

email boolean

marketing_sms boolean

marketing_email boolean

marketing_call boolean

language string

Responses

200

Successful response

application/json

Schema

Schema

id string
name string
surname stringnullable
type ContactTypeEnum (string)nullable

Possible values: [vendor, customer]

email emailnullable
phone phonenullable
gender ContactGenderEnum (string)nullable

Possible values: [male, female, other]

birthdate datenullable
address stringnullable
custom_fields objectnullable
created_at date-time
updated_at date-time
default_photo_id numbernullable

permissions

object

id string

contact_id string

gdpr boolean

sms boolean

email boolean

marketing_sms boolean

marketing_email boolean

marketing_call boolean

language string

updated_at date-time

Example (from schema)

{
  "id": "1",
  "name": "Kris",
  "surname": "Williamson",
  "type": "vendor",
  "email": "[email protected]",
  "phone": "5802777946",
  "gender": "male",
  "birthdate": "2011-05-02",
  "address": "İstanbul",
  "custom_fields": {},
  "created_at": "2024-03-03T11:52:04.398+03:00",
  "updated_at": "2024-04-11T01:11:23.878+03:00",
  "default_photo_id": 1,
  "permissions": {
    "id": "3",
    "contact_id": "101",
    "gdpr": false,
    "sms": true,
    "email": false,
    "marketing_sms": false,
    "marketing_email": false,
    "marketing_call": false,
    "language": "tr",
    "updated_at": "2024-07-31T17:47:33.768+03:00"
  }
}

Loading...