POST/contact-tags

Creates a company contact tag.

This API operation is available only when tags are enabled for the domain.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

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 

Tag name


required
maxLength : 30 

Request Example

example

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

Response

HTTP 201

OK

PropertyTypeDescription
contactTagId string 

Contact tag ID


readOnly : true 
contactTagName string 

Tag name


required
maxLength : 30 
type string 

Tag type

  • COMPANY: Company tag
  • USER: User tag

Allowed values : COMPANY, USER
readOnly : true 
userId string 

User tag creator

  • It is displayed only if ContactTagType is 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