Add tag to people batch

This method allows you to assign tag to multiple people.
NOTE Array size of the batch add request is limited to 1000 people.

Please log in to see full path URL. Learn why.

patch

/people/2/tags/{name}/persons

Authorizations:

Scopes:

people:manage

Request rate limit:

5 requests / second (per account)

Learn more

path Parameters

name

required

string

Example: Vip

Name of the tag.

Request Body schema:

collapse all -

people

Array of objects

List of people.

Array

query

object

identifier	string Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
sender	string Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`.
type	string Enum: "ID" "EXTERNAL_ID" "PHONE" "EMAIL" "LINE" "FACEBOOK" "TELEGRAM" "PUSH" "WEB_PUSH" "LIVE_CHAT" "VIBER_BOTS" "INSTAGRAM" "INSTAGRAM_DM" "TWITTER" "APPLE_BUSINESS_CHAT" "KAKAO_SANGDAM" "OPEN_CHANNEL" Type of the person ID. Can be one of the above

Responses

default

successful response

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

429

Too Many Requests

4XX

Error responses

500

Internal Server Error

5XX

Error responses

Request samples

Content type

Copy

Collapse all


{"people": 
[
{"query": 
{"type": "PHONE",
"identifier": "41793026727"
}
},
{"query": 
{"type": "EMAIL",
"identifier": "johnwilliams@acme.com"
}
},
{"query": 
{"type": "EXTERNAL_ID",
"identifier": "123"
}
}
]
}

Response samples

Content type

Copy

Collapse all


{"requestError": 
{"serviceException": 
{"messageId": "BAD_REQUEST",
"text": "Bad request"
}
}
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products

Learn more

Service status

Privacy documents Terms of use