Sign inGet Started

bird audiences remove-contacts

Usage

कोड उदाहरण
bird audiences remove-contacts <audience-id> [flags]

Description

Remove contacts from a static audience
Remove up to 1,000 contacts by id. Removing a contact that is not a member has no effect; if any id does not exist the whole request fails and no contacts are removed. The contacts themselves are not deleted. Pass --contact-ids (repeatable) or a --body-file with a "contact_ids" array.
Build the request from flags, a JSON AudienceContactsRemoveRequest body via --body-file ("-" reads stdin), or both — a flag overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Examples

कोड उदाहरण
# print the body shape (no credentials needed)
bird audiences remove-contacts --example

# the body it prints:
कोड उदाहरण
{
  "contact_ids": ["con_01krdgeqcxet5s7t44vh8rt9mg"]
}
कोड उदाहरण
# remove two contacts
bird audiences remove-contacts adn_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mg --contact-ids con_01krdgeqcxet5s7t44vh8rt9mh

Options

Contacts

NameDescription
--contact-ids <value>…Contact id to remove; repeatable

Request

NameDescription
--body-fileRead the JSON request body from this file; "-" reads stdin
--examplePrint a complete example request body, then exit
--dry-runPrint the resolved request without sending it, then exit
--idempotency-keyDeduplication key; a retry with the same key won't act twice

Options

NameDescription
--response-schemaPrint the fields this command returns, then exit
NameDescription
bird audiences add-contactsAdd contacts to a static audience
bird audiences createCreate an audience
bird audiences deleteDelete an audience
bird audiences getGet an audience
bird audiences listList audiences
bird audiences list-contactsList an audience's contacts
bird audiences remove-contactUnassign a contact from an audience
bird audiences updateUpdate an audience's name or description

संबंधित संसाधन

इस विषय के लिए डॉक्यूमेंटेशन, गाइड और उदाहरणों के साथ आगे बढ़ें। संसाधन अंग्रेज़ी में हैं।

इम्प्लीमेंटेशन ब्रीफ़ पाएँ