Apply a tag to matching contacts
POST
/api/v3/contacts/tags/{tagId}/apply
const url = 'https://api.tryletterhead.com/api/v3/contacts/tags/1/apply';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"api":true,"channelId":42,"status":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.tryletterhead.com/api/v3/contacts/tags/1/apply \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "api": true, "channelId": 42, "status": 1 }'Applies the tag to every contact matching the supplied filter — the same filter shape as Search contacts (query, tags, channelId, status). Omit all filters to apply the tag to your entire audience.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” tagId
required
integer
The tag’s numeric identifier.
Request Body required
Section titled “Request Body required ” Media type application/json
object
api
Required. Set to true to authenticate with an API key.
boolean
query
string
tags
Array<string>
channelId
integer
status
integer
Example
{ "api": true, "channelId": 42, "status": 1}Responses
Section titled “ Responses ”Successful response
Still can’t find what you need? Contact support.