고객 생성

고객을 생성합니다

POST

• Example Request

curl --location 'https://salesmap.kr/api/v1/people' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
  "name":"Exmaple_People",
  "ownerName":"지정담당자",
  "email":"[e-mail]",
  "phoneNumber":"01011112222",
  "memo": "고객 생성시 작성되는 노트입니다.",
  "fieldList": [
    {"name":"포지션", "stringValue":"CEO"}
  ],
  "organizationName":"Example_Organization"
  "organizationFieldList": [
    {"name":"주소", "stringValue":"서울시 강남구"},
    {"name":"직원수", "numberValue":"15"},
  ]
}
'

• Example Response

{
  "success": true,
  "data": {
    "id": "6451c769afa4b4ecff071ea9",
    "name": "Exmaple_People",
    "email": "[e-mail]",
    "phoneNumber": "01011112222",
    "organization": {
        "id": "6451c75bafa4b4ecff071bb9",
        "name": "Example_Organization"
    },
    "createdAt": "2023-05-03T02:31:05.000Z"
  }
}

Header

• Authorization

  • required string

Bearer 토큰을 포함한 인증 헤더입니다.

​Body

• name

  • required string

  • 고객의 이름을 설정합니다.

• ownerName

  • string

  • 고객의 담당자를 지정합니다.

  • 같은 워크스페이스에 등록된 담당자의 이름을 지정해주세요.

  • 해당필드 없이 post 요청을 하면, 해당 요청의 토큰에 해당하는 user가 담당자로 지정됩니다.

• memo

  • string

  • 고객의 생성과 동시에 해당 고객에 작성할 노트의 본문 내용입니다.

• email

  • string

  • 고객의 이메일을 설정합니다. 같은 이메일이 존재하는 경우 생성할 수 없습니다.

• phoneNumber

  • string

  • 고객의 전화번호를 설정합니다.

• fieldList

  • json

  • 고객의 이름과 이메일을 제외한 필드값을 설정합니다. 세일즈맵 탭에서 [회사 설정] - [데이터 필드 관리]을 클릭하면 고객의 데이터 필드를 확인할 수 있습니다.

  • name 에는 field 의 이름을 입력합니다.

  • field 의 유형이 텍스트나 단일 선택인 경우에는 stringValue 에 값을 설정하고, field 의 유형이 숫자인 경우에는 numberValue 에 값을 설정하고, field 의 유형이 날짜인 경우에는 dateValue 에 값을 설정합니다. field 의 유형이 복수 선택인 경우에는 stringValueList에 string list 형태로 값을 설정합니다.

• organizationName

  • string

  • 고객과 연결된 회사의 이름을 설정합니다.

  • 같은 이름의 회사가 존재하는 경우 기존의 회사와 연결하고, 같은 이름의 회사가 존재하지 않는 경우 새로운 회사를 생성하고 고객와 연결합니다.

• organizationFieldList

  • json

  • 고객과 연결된 회사의 이름을 제외한 필드값을 설정합니다. 세일즈맵 탭에서 [회사 설정] - [데이터 필드 관리]을 클릭하면 회사의 데이터 필드를 확인할 수 있습니다.

  • name 에는 field 의 이름을 입력합니다.

  • field 의 유형이 텍스트나 단일 선택인 경우에는 stringValue 에 값을 설정하고, field 의 유형이 숫자인 경우에는 numberValue 에 값을 설정하고, field 의 유형이 날짜인 경우에는 dateValue 에 값을 설정합니다. field 의 유형이 복수 선택인 경우에는 stringValueList에 string list 형태로 값을 설정합니다.

​Response

• success

  • boolean

  • 요청을 성공적으로 완료한 경우 true, 실패한 경우 false 입니다.

• data

  • object

  • 생성한 고객 정보입니다.

  • 고객 정보 데이터

    • id

      • string

      • 고객의 고유 id 입니다. 고객을 생성할 때 사용합니다.

    • name

      • string

      • 생성한 고객의 이름입니다.

    • email

      • string

      • 생성한 고객의 이메일입니다.

    • phoneNumber

      • string

      • 생성한 고객의 전화 번호입니다.

    • organization

      • string

      • 생성한 고객의 회사 정보입니다.

    • createdAt

      • string

      • 고객이 생성된 날짜입니다.