의뢰 부분 수정

curl --request PATCH \
  --url https://openapi.pluuug.com/v1/inquiry/{inquiry_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "status": {
    "id": 123
  },
  "client": {
    "id": 123
  },
  "contract": {
    "id": 123
  },
  "name": "<string>",
  "content": "<string>",
  "estimate": "<string>",
  "inquiryDate": "2023-12-25",
  "funnel": {
    "utmCampaign": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmContent": "<string>",
    "utmTerm": "<string>",
    "guestUid": "<string>",
    "gclid": "<string>"
  },
  "workSet": [
    {
      "name": "<string>"
    }
  ],
  "inChargeSet": [
    {
      "id": 123
    }
  ],
  "fieldSet": [
    {
      "field": {
        "id": 123
      },
      "value": "<string>"
    }
  ],
  "fileLinkSet": [
    {
      "text": "<string>",
      "link": "<string>"
    }
  ],
  "fileSet": [
    {
      "name": "<string>",
      "file": "<string>"
    }
  ]
}
'

import requests

url = "https://openapi.pluuug.com/v1/inquiry/{inquiry_id}"

payload = {
    "status": { "id": 123 },
    "client": { "id": 123 },
    "contract": { "id": 123 },
    "name": "<string>",
    "content": "<string>",
    "estimate": "<string>",
    "inquiryDate": "2023-12-25",
    "funnel": {
        "utmCampaign": "<string>",
        "utmSource": "<string>",
        "utmMedium": "<string>",
        "utmContent": "<string>",
        "utmTerm": "<string>",
        "guestUid": "<string>",
        "gclid": "<string>"
    },
    "workSet": [{ "name": "<string>" }],
    "inChargeSet": [{ "id": 123 }],
    "fieldSet": [
        {
            "field": { "id": 123 },
            "value": "<string>"
        }
    ],
    "fileLinkSet": [
        {
            "text": "<string>",
            "link": "<string>"
        }
    ],
    "fileSet": [
        {
            "name": "<string>",
            "file": "<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},
    client: {id: 123},
    contract: {id: 123},
    name: '<string>',
    content: '<string>',
    estimate: '<string>',
    inquiryDate: '2023-12-25',
    funnel: {
      utmCampaign: '<string>',
      utmSource: '<string>',
      utmMedium: '<string>',
      utmContent: '<string>',
      utmTerm: '<string>',
      guestUid: '<string>',
      gclid: '<string>'
    },
    workSet: [{name: '<string>'}],
    inChargeSet: [{id: 123}],
    fieldSet: [{field: {id: 123}, value: '<string>'}],
    fileLinkSet: [{text: '<string>', link: '<string>'}],
    fileSet: [{name: '<string>', file: '<string>'}]
  })
};

fetch('https://openapi.pluuug.com/v1/inquiry/{inquiry_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/inquiry/{inquiry_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
    ],
    'client' => [
        'id' => 123
    ],
    'contract' => [
        'id' => 123
    ],
    'name' => '<string>',
    'content' => '<string>',
    'estimate' => '<string>',
    'inquiryDate' => '2023-12-25',
    'funnel' => [
        'utmCampaign' => '<string>',
        'utmSource' => '<string>',
        'utmMedium' => '<string>',
        'utmContent' => '<string>',
        'utmTerm' => '<string>',
        'guestUid' => '<string>',
        'gclid' => '<string>'
    ],
    'workSet' => [
        [
                'name' => '<string>'
        ]
    ],
    'inChargeSet' => [
        [
                'id' => 123
        ]
    ],
    'fieldSet' => [
        [
                'field' => [
                                'id' => 123
                ],
                'value' => '<string>'
        ]
    ],
    'fileLinkSet' => [
        [
                'text' => '<string>',
                'link' => '<string>'
        ]
    ],
    'fileSet' => [
        [
                'name' => '<string>',
                'file' => '<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/inquiry/{inquiry_id}"

	payload := strings.NewReader("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<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/inquiry/{inquiry_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  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.pluuug.com/v1/inquiry/{inquiry_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  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<string>\"\n    }\n  ]\n}"

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

{
  "id": 123,
  "uniqueId": "<string>",
  "name": "<string>",
  "inquiryDate": "2023-12-25",
  "created": "2023-11-07T05:31:56Z",
  "fileSet": [
    {
      "id": 123,
      "name": "<string>",
      "file": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "status": {
    "id": 123,
    "title": "<string>",
    "folder": {
      "id": 123,
      "name": "<string>"
    }
  },
  "client": {
    "id": 123,
    "status": {
      "id": 123,
      "title": "<string>"
    },
    "companyName": "<string>",
    "inCharge": "<string>",
    "position": "<string>",
    "contact": "<string>",
    "email": "jsmith@example.com"
  },
  "contract": {
    "id": 123,
    "title": "<string>",
    "amount": 123,
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "content": "<string>",
  "estimate": "<string>",
  "funnel": {
    "utmCampaign": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmContent": "<string>",
    "utmTerm": "<string>",
    "guestUid": "<string>",
    "gclid": "<string>"
  },
  "workSet": [
    {
      "name": "<string>"
    }
  ],
  "inChargeSet": [
    {
      "id": 123,
      "nickname": "<string>",
      "email": "<string>",
      "isActive": true,
      "grade": {
        "id": 123,
        "title": "<string>"
      }
    }
  ],
  "fieldSet": [
    {
      "field": {
        "id": 123,
        "name": "<string>",
        "optionSet": [
          {
            "id": "<string>",
            "title": "<string>"
          }
        ],
        "memberSet": [
          {
            "id": 123,
            "nickname": "<string>",
            "email": "<string>",
            "isActive": true,
            "grade": {
              "id": 123,
              "title": "<string>"
            }
          }
        ]
      },
      "value": "<string>"
    }
  ],
  "fileLinkSet": [
    {
      "id": 123,
      "text": "<string>",
      "link": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "nonField": [
    "<string>"
  ],
  "status": {
    "id": [
      "<string>"
    ]
  },
  "client": {
    "id": [
      "<string>"
    ]
  },
  "contract": {
    "id": [
      "<string>"
    ]
  },
  "name": [
    "<string>"
  ],
  "content": [
    "<string>"
  ],
  "estimate": [
    "<string>"
  ],
  "inquiryDate": [
    "<string>"
  ],
  "funnel": {
    "utmCampaign": [
      "<string>"
    ],
    "utmSource": [
      "<string>"
    ],
    "utmMedium": [
      "<string>"
    ],
    "utmContent": [
      "<string>"
    ],
    "utmTerm": [
      "<string>"
    ],
    "guestUid": [
      "<string>"
    ],
    "gclid": [
      "<string>"
    ]
  },
  "workSet": [
    "<string>"
  ],
  "inChargeSet": [
    "<string>"
  ],
  "fieldSet": [
    "<string>"
  ],
  "fileLinkSet": [
    "<string>"
  ],
  "fileSet": [
    "<string>"
  ]
}

의뢰

의뢰 부분 수정

의뢰 정보를 부분 수정합니다.

파일 추가: file_set에 presigned API로 발급받은 name과 path를 전달하면 기존 파일은 유지한 채 새 파일만 추가됩니다 (append). 파일 삭제는 별도의 DELETE API를 사용하세요. 최대 30개까지 첨부 가능합니다 (기존 + 추가분 합산).

부수효과:

status 변경 시: InquiryStatusHistory 자동 생성, folder가 함께 바뀌면 InquiryFolderHistory도 생성. 알림 설정이 켜진 담당자에게 상태 변경 알림 발송.
in_charge_set 변경 시: 신규 담당자에게 ‘XX 담당자로 지정되었어요’ 알림 발송 (알림 설정 켜진 경우).
알림은 모두 비동기 처리 (transaction.on_commit 후 Celery task 발송).

PATCH

inquiry

{inquiry_id}

의뢰 부분 수정

curl --request PATCH \
  --url https://openapi.pluuug.com/v1/inquiry/{inquiry_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-Signature: <api-key>' \
  --data '
{
  "status": {
    "id": 123
  },
  "client": {
    "id": 123
  },
  "contract": {
    "id": 123
  },
  "name": "<string>",
  "content": "<string>",
  "estimate": "<string>",
  "inquiryDate": "2023-12-25",
  "funnel": {
    "utmCampaign": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmContent": "<string>",
    "utmTerm": "<string>",
    "guestUid": "<string>",
    "gclid": "<string>"
  },
  "workSet": [
    {
      "name": "<string>"
    }
  ],
  "inChargeSet": [
    {
      "id": 123
    }
  ],
  "fieldSet": [
    {
      "field": {
        "id": 123
      },
      "value": "<string>"
    }
  ],
  "fileLinkSet": [
    {
      "text": "<string>",
      "link": "<string>"
    }
  ],
  "fileSet": [
    {
      "name": "<string>",
      "file": "<string>"
    }
  ]
}
'

import requests

url = "https://openapi.pluuug.com/v1/inquiry/{inquiry_id}"

payload = {
    "status": { "id": 123 },
    "client": { "id": 123 },
    "contract": { "id": 123 },
    "name": "<string>",
    "content": "<string>",
    "estimate": "<string>",
    "inquiryDate": "2023-12-25",
    "funnel": {
        "utmCampaign": "<string>",
        "utmSource": "<string>",
        "utmMedium": "<string>",
        "utmContent": "<string>",
        "utmTerm": "<string>",
        "guestUid": "<string>",
        "gclid": "<string>"
    },
    "workSet": [{ "name": "<string>" }],
    "inChargeSet": [{ "id": 123 }],
    "fieldSet": [
        {
            "field": { "id": 123 },
            "value": "<string>"
        }
    ],
    "fileLinkSet": [
        {
            "text": "<string>",
            "link": "<string>"
        }
    ],
    "fileSet": [
        {
            "name": "<string>",
            "file": "<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},
    client: {id: 123},
    contract: {id: 123},
    name: '<string>',
    content: '<string>',
    estimate: '<string>',
    inquiryDate: '2023-12-25',
    funnel: {
      utmCampaign: '<string>',
      utmSource: '<string>',
      utmMedium: '<string>',
      utmContent: '<string>',
      utmTerm: '<string>',
      guestUid: '<string>',
      gclid: '<string>'
    },
    workSet: [{name: '<string>'}],
    inChargeSet: [{id: 123}],
    fieldSet: [{field: {id: 123}, value: '<string>'}],
    fileLinkSet: [{text: '<string>', link: '<string>'}],
    fileSet: [{name: '<string>', file: '<string>'}]
  })
};

fetch('https://openapi.pluuug.com/v1/inquiry/{inquiry_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/inquiry/{inquiry_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
    ],
    'client' => [
        'id' => 123
    ],
    'contract' => [
        'id' => 123
    ],
    'name' => '<string>',
    'content' => '<string>',
    'estimate' => '<string>',
    'inquiryDate' => '2023-12-25',
    'funnel' => [
        'utmCampaign' => '<string>',
        'utmSource' => '<string>',
        'utmMedium' => '<string>',
        'utmContent' => '<string>',
        'utmTerm' => '<string>',
        'guestUid' => '<string>',
        'gclid' => '<string>'
    ],
    'workSet' => [
        [
                'name' => '<string>'
        ]
    ],
    'inChargeSet' => [
        [
                'id' => 123
        ]
    ],
    'fieldSet' => [
        [
                'field' => [
                                'id' => 123
                ],
                'value' => '<string>'
        ]
    ],
    'fileLinkSet' => [
        [
                'text' => '<string>',
                'link' => '<string>'
        ]
    ],
    'fileSet' => [
        [
                'name' => '<string>',
                'file' => '<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/inquiry/{inquiry_id}"

	payload := strings.NewReader("{\n  \"status\": {\n    \"id\": 123\n  },\n  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<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/inquiry/{inquiry_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  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://openapi.pluuug.com/v1/inquiry/{inquiry_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  \"client\": {\n    \"id\": 123\n  },\n  \"contract\": {\n    \"id\": 123\n  },\n  \"name\": \"<string>\",\n  \"content\": \"<string>\",\n  \"estimate\": \"<string>\",\n  \"inquiryDate\": \"2023-12-25\",\n  \"funnel\": {\n    \"utmCampaign\": \"<string>\",\n    \"utmSource\": \"<string>\",\n    \"utmMedium\": \"<string>\",\n    \"utmContent\": \"<string>\",\n    \"utmTerm\": \"<string>\",\n    \"guestUid\": \"<string>\",\n    \"gclid\": \"<string>\"\n  },\n  \"workSet\": [\n    {\n      \"name\": \"<string>\"\n    }\n  ],\n  \"inChargeSet\": [\n    {\n      \"id\": 123\n    }\n  ],\n  \"fieldSet\": [\n    {\n      \"field\": {\n        \"id\": 123\n      },\n      \"value\": \"<string>\"\n    }\n  ],\n  \"fileLinkSet\": [\n    {\n      \"text\": \"<string>\",\n      \"link\": \"<string>\"\n    }\n  ],\n  \"fileSet\": [\n    {\n      \"name\": \"<string>\",\n      \"file\": \"<string>\"\n    }\n  ]\n}"

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

{
  "id": 123,
  "uniqueId": "<string>",
  "name": "<string>",
  "inquiryDate": "2023-12-25",
  "created": "2023-11-07T05:31:56Z",
  "fileSet": [
    {
      "id": 123,
      "name": "<string>",
      "file": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ],
  "status": {
    "id": 123,
    "title": "<string>",
    "folder": {
      "id": 123,
      "name": "<string>"
    }
  },
  "client": {
    "id": 123,
    "status": {
      "id": 123,
      "title": "<string>"
    },
    "companyName": "<string>",
    "inCharge": "<string>",
    "position": "<string>",
    "contact": "<string>",
    "email": "jsmith@example.com"
  },
  "contract": {
    "id": 123,
    "title": "<string>",
    "amount": 123,
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "content": "<string>",
  "estimate": "<string>",
  "funnel": {
    "utmCampaign": "<string>",
    "utmSource": "<string>",
    "utmMedium": "<string>",
    "utmContent": "<string>",
    "utmTerm": "<string>",
    "guestUid": "<string>",
    "gclid": "<string>"
  },
  "workSet": [
    {
      "name": "<string>"
    }
  ],
  "inChargeSet": [
    {
      "id": 123,
      "nickname": "<string>",
      "email": "<string>",
      "isActive": true,
      "grade": {
        "id": 123,
        "title": "<string>"
      }
    }
  ],
  "fieldSet": [
    {
      "field": {
        "id": 123,
        "name": "<string>",
        "optionSet": [
          {
            "id": "<string>",
            "title": "<string>"
          }
        ],
        "memberSet": [
          {
            "id": 123,
            "nickname": "<string>",
            "email": "<string>",
            "isActive": true,
            "grade": {
              "id": 123,
              "title": "<string>"
            }
          }
        ]
      },
      "value": "<string>"
    }
  ],
  "fileLinkSet": [
    {
      "id": 123,
      "text": "<string>",
      "link": "<string>",
      "created": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "nonField": [
    "<string>"
  ],
  "status": {
    "id": [
      "<string>"
    ]
  },
  "client": {
    "id": [
      "<string>"
    ]
  },
  "contract": {
    "id": [
      "<string>"
    ]
  },
  "name": [
    "<string>"
  ],
  "content": [
    "<string>"
  ],
  "estimate": [
    "<string>"
  ],
  "inquiryDate": [
    "<string>"
  ],
  "funnel": {
    "utmCampaign": [
      "<string>"
    ],
    "utmSource": [
      "<string>"
    ],
    "utmMedium": [
      "<string>"
    ],
    "utmContent": [
      "<string>"
    ],
    "utmTerm": [
      "<string>"
    ],
    "guestUid": [
      "<string>"
    ],
    "gclid": [
      "<string>"
    ]
  },
  "workSet": [
    "<string>"
  ],
  "inChargeSet": [
    "<string>"
  ],
  "fieldSet": [
    "<string>"
  ],
  "fileLinkSet": [
    "<string>"
  ],
  "fileSet": [
    "<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

inquiry_id

integer

required

Body

status

null | object

의뢰 상태

Show child attributes

client

null | object

고객

Show child attributes

contract

null | object

계약

Show child attributes

name

string

의뢰 이름

Required string length: 1 - 64

content

string | null

의뢰 내용

Minimum string length: 1

estimate

string<decimal> | null

예상 견적

Pattern: ^-?\d{0,28}(?:\.\d{0,2})?$

inquiryDate

string<date>

문의 일시

funnel

null | object

유입 경로

Show child attributes

workSet

object[] | null

의뢰 업무

Show child attributes

inChargeSet

object[] | null

영업 담당자

Show child attributes

fieldSet

object[] | null

커스텀 필드

Show child attributes

fileLinkSet

object[] | null

링크 첨부

Show child attributes

fileSet

object[] | null

파일 추가 (기존 파일 유지, 새 파일만 추가). 삭제는 DELETE /v1/inquiry/{inquiry_id}/file/{file_id} 사용. 최대 30개 (합산).

Show child attributes

Response

GET 응답 스키마 전용 — file_set을 조회용 serializer로 선언

integer

required

read-only

uniqueId

string | null

required

read-only

의뢰 고유번호

name

string

required

의뢰 이름

Maximum string length: 64

inquiryDate

string<date>

required

문의 일시

created

string<date-time>

required

read-only

생성일시

fileSet

object[]

required

read-only

첨부 파일 (presigned 다운로드 URL 포함)

Show child attributes

status

null | object

의뢰 상태

Show child attributes

client

null | object

고객

Show child attributes

contract

null | object

계약

Show child attributes

content

string | null

의뢰 내용

estimate

string<decimal> | null

예상 견적

Pattern: ^-?\d{0,28}(?:\.\d{0,2})?$

funnel

null | object

유입 경로

Show child attributes

workSet

object[] | null

의뢰 업무

Show child attributes

inChargeSet

object[] | null

영업 담당자

Show child attributes

fieldSet

object[] | null

커스텀 필드

Show child attributes

fileLinkSet

object[] | null

링크 첨부

Show child attributes

​커스텀 필드

Authorizations

Path Parameters

Body

Response

커스텀 필드