Skip to main content
POST
/
v1
/
inquiry
의뢰 생성
curl --request POST \
  --url https://openapi.pluuug.com/v1/inquiry \
  --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>"
    }
  ]
}
'
{
  "id": 123,
  "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,
    "type": "I",
    "status": "P",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25"
  },
  "name": "<string>",
  "estimate": "<string>",
  "inquiryDate": "2023-12-25"
}

커스텀 필드

  • 플러그 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로 서명을 검증합니다.

Body

status
object

의뢰 상태 (미입력 시 기본 폴더의 기본 상태)

client
object

고객

contract
object

계약

name
string | null

의뢰 이름 (미입력 시 '의뢰 제목')

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> | null

문의 일시 (미입력 시 오늘 날짜)

funnel
object

유입 경로

workSet
object[] | null

의뢰 업무

inChargeSet
object[] | null

영업 담당자

fieldSet
object[] | null

커스텀 필드

링크 첨부

Response

id
integer
required
created
string<date-time>
required

생성일시

status
object

의뢰 상태 (미입력 시 기본 폴더의 기본 상태)

client
object

고객

contract
object

계약

name
string | null

의뢰 이름 (미입력 시 '의뢰 제목')

Maximum string length: 64
estimate
string<decimal> | null

예상 견적

Pattern: ^-?\d{0,28}(?:\.\d{0,2})?$
inquiryDate
string<date> | null

문의 일시 (미입력 시 오늘 날짜)