POST/contact-tags

会社の連絡先タグを登録する。

  • ドメインオプションに応じて権限がある場合にのみ登録できる。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

contact

HTTP Request

POSThttps://www.worksapis.com/v1.0/contact-tags

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
contactTagName string 

タグ名


required
maxLength : 30 

Request Example

example

1{2  "contactTagName": "company tag"3}

Response

HTTP 201

OK

PropertyTypeDescription
contactTagId string 

連絡先タグ ID


readOnly : true 
contactTagName string 

タグ名


required
maxLength : 30 
type string 

タグタイプ

  • COMPANY : 会社タグ
  • USER : ユーザータグ

Allowed values : COMPANY, USER
readOnly : true 
userId string 

マイタグの作成者

  • タグタイプが USER の場合のみ表示される。

readOnly : true 

Response Example

example

1{2  "contactTagId": "ctag2a81-94b6-4642-6903-03aa7977da91",3  "contactTagName": "company tag",4  "type": "COMPANY"5}

HTTP 400

Bad Request

HTTP 403

Forbidden