Add a Tag to an Entity

Add tags to Jobs, Contact Notes and Sales Opportunities.

Name	Type	Description	Required
Action	String	SetTag	Required
EntityTypeId	String	The type of the identifier of the entity type to which the tag is being applied.	Optional
EntityType	String	The string identifier of the entity type to which the tag is being applied ie Job, ContactNote. Only used if `EntityTypeId` is not provided.	Optional
EntityId	Int	The identifier of the entity to which the tag is being applied. ie: JobId, ContactNoteId. To apply the tag to multiple entities, provide the parameter multiple times or as a CSV value.	Required
TagId	Int	The unique identifier of the tag being applied. Can be retrieved using Get list of Tags	Required
OwnerName	String	The name of the person or system responsible for the tag.	Optional
Comment	String	Additional comments or notes about the tag.	Optional
DateTime	DateTime	The date and time when the tag is applied.	Optional
ReturnType	Int	Specifies the expected return value after applying the tag. Use `0` for no return (default), or `1` to return the `EntityId`.	Optional

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Missing or Invalid Parameter - TagId	Integer value is invalid or was not specified (when required)
2	Missing Parameter - EntityTypeId or EntityType	Integer value is invalid or was not specified (when required)
2	Invalid format - EntityTypeId	Unrecognized constant value - please verify the supported values
2	Invalid format - EntityType	Unrecognized constant value - please verify the supported values
2	Missing or Invalid Parameter - EntityId	Integer value is invalid or was not specified (when required)
2	Invalid Parameter value - returnType	Integer value is invalid or was not specified (when required)

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=settag&tagid=212108&entitytypeid=3&entityid=127596563&returntype=1

{
  "Code": 0,
  "Result": [
    127596563
  ]
}