고객 부분 수정 - 플러그 개발자 센터

고객 부분 수정

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>"
    }
  ]
}
'

import requests

url = "https://openapi.pluuug.com/v1/client/{client_id}"

payload = {
    "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>"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "X-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-Key': '<api-key>',
    'X-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'}]
  })
};

fetch('https://openapi.pluuug.com/v1/client/{client_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openapi.pluuug.com/v1/client/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openapi.pluuug.com/v1/client/{client_id}"

	payload := strings.NewReader("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://openapi.pluuug.com/v1/client/{client_id}")
  .header("X-API-Key", "<api-key>")
  .header("X-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.pluuug.com/v1/client/{client_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
    }
  ]
}

{
  "nonField": [
    "<string>"
  ],
  "status": {
    "id": [
      "<string>"
    ]
  },
  "companyName": [
    "<string>"
  ],
  "inCharge": [
    "<string>"
  ],
  "position": [
    "<string>"
  ],
  "contact": [
    "<string>"
  ],
  "email": [
    "<string>"
  ],
  "content": [
    "<string>"
  ],
  "businessRegistrationNumber": [
    "<string>"
  ],
  "ceoName": [
    "<string>"
  ],
  "companyAddress": [
    "<string>"
  ],
  "companyDetailAddress": [
    "<string>"
  ],
  "businessType": [
    "<string>"
  ],
  "businessClass": [
    "<string>"
  ],
  "branchNumber": [
    "<string>"
  ],
  "taxInvoiceEmail": [
    "<string>"
  ],
  "fieldSet": [
    "<string>"
  ]
}

PATCH

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>"
    }
  ]
}
'

import requests

url = "https://openapi.pluuug.com/v1/client/{client_id}"

payload = {
    "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>"
        }
    ]
}
headers = {
    "X-API-Key": "<api-key>",
    "X-Signature": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'X-API-Key': '<api-key>',
    'X-Signature': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    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>'}]
  })
};

fetch('https://openapi.pluuug.com/v1/client/{client_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openapi.pluuug.com/v1/client/{client_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>",
    "X-Signature: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openapi.pluuug.com/v1/client/{client_id}"

	payload := strings.NewReader("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("X-Signature", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://openapi.pluuug.com/v1/client/{client_id}")
  .header("X-API-Key", "<api-key>")
  .header("X-Signature", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.pluuug.com/v1/client/{client_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["X-Signature"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"status\": {\n    \"id\": 123\n  },\n  \"companyName\": \"<string>\",\n  \"inCharge\": \"<string>\",\n  \"position\": \"<string>\",\n  \"contact\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"content\": \"<string>\",\n  \"businessRegistrationNumber\": \"<string>\",\n  \"ceoName\": \"<string>\",\n  \"companyAddress\": \"<string>\",\n  \"companyDetailAddress\": \"<string>\",\n  \"businessType\": \"<string>\",\n  \"businessClass\": \"<string>\",\n  \"branchNumber\": \"<string>\",\n  \"taxInvoiceEmail\": \"<string>\",\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "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>"
    }
  ]
}

{
  "nonField": [
    "<string>"
  ],
  "status": {
    "id": [
      "<string>"
    ]
  },
  "companyName": [
    "<string>"
  ],
  "inCharge": [
    "<string>"
  ],
  "position": [
    "<string>"
  ],
  "contact": [
    "<string>"
  ],
  "email": [
    "<string>"
  ],
  "content": [
    "<string>"
  ],
  "businessRegistrationNumber": [
    "<string>"
  ],
  "ceoName": [
    "<string>"
  ],
  "companyAddress": [
    "<string>"
  ],
  "companyDetailAddress": [
    "<string>"
  ],
  "businessType": [
    "<string>"
  ],
  "businessClass": [
    "<string>"
  ],
  "branchNumber": [
    "<string>"
  ],
  "taxInvoiceEmail": [
    "<string>"
  ],
  "fieldSet": [
    "<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

null | object

고객 상태

Show child attributes

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

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

커스텀 필드

Show child attributes

Response

integer

required

read-only

companyName

string

required

회사명

Maximum string length: 128

created

string<date-time>

required

read-only

생성일시

status

null | object

고객 상태

Show child attributes

inCharge

string | null

담당자

Maximum string length: 64

position

string | null

직책

Maximum string length: 64

contact

string | null

연락처

Maximum string length: 128

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

커스텀 필드

Show child attributes

​커스텀 필드

Authorizations

Path Parameters

Body

Response

커스텀 필드