Skip to main content
PATCH
/
v1
/
client
/
{client_id}
고객 부분 수정
curl --request PATCH \
  --url https://openapi.pluuug.com/v1/client/{client_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "status": {
    "id": 123
  },
  "companyName": "<string>",
  "inCharge": "<string>",
  "position": "<string>",
  "contact": "<string>",
  "email": "jsmith@example.com",
  "content": "<string>",
  "businessRegistrationNumber": "<string>",
  "ceoName": "<string>",
  "companyAddress": "<string>",
  "companyDetailAddress": "<string>",
  "businessType": "<string>",
  "businessClass": "<string>",
  "branchNumber": "<string>",
  "taxInvoiceEmail": "<string>",
  "fieldSet": [
    {
      "field": {
        "id": 123
      },
      "value": "<string>"
    }
  ]
}
'
{
  "id": 123,
  "companyName": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "status": {
    "id": 123,
    "title": "<string>"
  },
  "inCharge": "<string>",
  "position": "<string>",
  "contact": "<string>",
  "email": "jsmith@example.com",
  "content": "<string>",
  "businessRegistrationNumber": "<string>",
  "ceoName": "<string>",
  "companyAddress": "<string>",
  "companyDetailAddress": "<string>",
  "businessType": "<string>",
  "businessClass": "<string>",
  "branchNumber": "<string>",
  "taxInvoiceEmail": "<string>",
  "fieldSet": [
    {
      "field": {
        "id": 123,
        "name": "<string>",
        "dataType": "S",
        "optionSet": [
          {
            "id": "<string>",
            "title": "<string>"
          }
        ],
        "memberSet": [
          {
            "id": 123,
            "nickname": "<string>",
            "email": "<string>",
            "isActive": true,
            "grade": {
              "id": 123,
              "title": "<string>"
            }
          }
        ]
      },
      "value": "<string>"
    }
  ]
}

​
커스텀 필드

  • 플러그 Openapi는 고객의 커스텀 필드 값 수정을 지원합니다.
  • 커스텀 필드 자체의 수정은 비즈니스 설정 - 필드 설정 탭에서 수정하실 수 있습니다.
  • 수정 API의 field_set 필드를 활용하여 각 커스텀 필드의 값을 수정하실 수 있습니다.
  • 커스텀 필드는 총 8가지의 타입을 지원합니다.
  • 데이터 입력 예
데이터 타입입력 예시
텍스트 (String)
{
    “field”: {
         “id”: 1
    },
    “value”: “text”
}
숫자 (Number)
  • 소수점 입력 가능
{
    “field”: {
         “id”: 2
    },
    “value”: 12345
}
멤버 (Member)
  • 해당 필드의 ‘member_set’에서 id 선택
{
    “field”: {
         “id”: 3
    },
    “value”: [
        {
            “id”: 1
        },
        {
            “id”: 2
        }
    ]
}
날짜 (Date)
{
    “field”: {
         “id”: 4
    },
    “value”: “2025-03-01”
}
시간 (Time)
{
    “field”: {
         “id”: 5
    },
    “value”: “10:00:00”
}
토글 (Boolean)
{
    “field”: {
         “id”: 6
    },
    “value”: true
}
단수선택 리스트 (Single List)
  • 해당 필드의 ‘option_set’에서 id 선택
{
    “field”: {
         “id”: 7
    },
    “value”: {
        “id”: “FEWKSLVE2”
    }
}
복수선택 리스트 (Multi List)
  • 해당 필드의 ‘option_set’에서 id 선택
{
    “field”: {
         “id”: 8
    },
    “value”: [
        {
            “id”: “EFI4VLB2D”
        },
        {
            “id”: “BORE32VKE”
        }
    ]
}

Authorizations

​
X-API-Key
string
header
required
​
X-Signature
string
header
required

HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다. 서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.

Path Parameters

​
client_id
integer
required

Body

​
status
object

고객 상태

​
companyName
string

회사명

Required string length: 1 - 128
​
inCharge
string | null

담당자

Required string length: 1 - 64
​
position
string | null

직책

Required string length: 1 - 64
​
contact
string | null

연락처

Required string length: 1 - 128
​
email
string<email> | null

이메일

Required string length: 1 - 128
​
content
string | null

메모

Minimum string length: 1
​
businessRegistrationNumber
string | null

사업자 등록번호

Required string length: 1 - 16
​
ceoName
string | null

대표자

Required string length: 1 - 128
​
companyAddress
string | null

소재지

Required string length: 1 - 256
​
companyDetailAddress
string | null

소재지 상세

Required string length: 1 - 256
​
businessType
string | null

업태

Required string length: 1 - 128
​
businessClass
string | null

종목

Required string length: 1 - 128
​
branchNumber
string | null

종사업장 번호

Required string length: 1 - 4
​
taxInvoiceEmail
string | null

세금계산서 전용 이메일

Required string length: 1 - 128
​
fieldSet
object[] | null

커스텀 필드

Response

​
id
integer
required
​
companyName
string
required

회사명

Maximum string length: 128
​
created
string<date-time>
required

생성일시

​
status
object

고객 상태

​
inCharge
string | null

담당자

Maximum string length: 64
​
position
string | null

직책

Maximum string length: 64
​
contact
string | null

연락처

Maximum string length: 128
​
email
string<email> | null

이메일

Maximum string length: 128
​
content
string | null

메모

​
businessRegistrationNumber
string | null

사업자 등록번호

Maximum string length: 16
​
ceoName
string | null

대표자

Maximum string length: 128
​
companyAddress
string | null

소재지

Maximum string length: 256
​
companyDetailAddress
string | null

소재지 상세

Maximum string length: 256
​
businessType
string | null

업태

Maximum string length: 128
​
businessClass
string | null

종목

Maximum string length: 128
​
branchNumber
string | null

종사업장 번호

Maximum string length: 4
​
taxInvoiceEmail
string | null

세금계산서 전용 이메일

Maximum string length: 128
​
fieldSet
object[] | null

커스텀 필드