REST API V3 / Tags / Manage

URL

Apply Tags

PUT /wp-json/gh/v3/contacts/apply_tags

PUT /wp-json/gh/v3/tags/apply

Remove Tags

PUT /wp-json/gh/v3/contacts/apply_tags

PUT /wp-json/gh/v3/tags/remove

Method

This endpoint supports the PUT method.

Request

This endpoint provides functionality to manage tags applied to the contact.

PARAM	TYPE	REQUIRED	DESCRIPTION
`id_or_email`	string/int	yes	Contact id.
`tags`	array	yes	ID or name of tag which you want to apply or remove from the contact.
`by_user_id`	bool	no	Fetches the contact using user ID.

Example

Here is an example of a request body that applies tags to the contact. You can use the same body to remove tags from the contact by making requests to the remove tag URI.

{
    "id_or_email":"1",
    "tags" : [ 
        1, 
        2, 
        3, 
        "user", 
        "confirm" 
    ]
}

Response

If the request to the URI is successful you will get a 200 OK response with the status success.

{     
	"status": "success" 
}