Update BrevoContact - tsubotitsch/Brevo GitHub Wiki

Update-BrevoContact

SYNOPSIS

Updates a contact in Brevo.

SYNTAX

Update-BrevoContact [-Identifier] <String> [[-ext_id] <String>] [[-emailBlacklisted] <Boolean>]
 [[-smsBlacklisted] <Boolean>] [[-ListIds] <Int32[]>] [[-unlinkListIds] <Int32[]>] [[-attributes] <Object>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function updates a contact in Brevo using the provided identifier and optional parameters. It supports updating email and SMS blacklisting status, adding and removing contact from lists, and updating contact attributes.

EXAMPLES

EXAMPLE 1

Update-BrevoContact -Identifier "contact_id" -emailBlacklisted $true -ListIds @(1,2,3) -attributes @{"FIRSTNAME"="John"; "LASTNAME"="Doe"}

This command updates the contact with the specified identifier, sets the email blacklisting status to true, adds the contact to lists with IDs 1, 2, and 3, and updates the contact's first name and last name.

PARAMETERS

-attributes

Optional. Pass the set of attributes and their values. The attributes parameter should be passed in capital letters while creating a contact. Values that don't match the attribute type (e.g., text or string in a date attribute) will be ignored. These attributes must be present in your Brevo account. For example: -Attributes @{"FIRSTNAME"="John"; "LASTNAME"="Doe"}

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-emailBlacklisted

Optional. Set/unset this field to blacklist/allow the contact for emails.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ext_id

Optional. Pass your own Id to create a contact.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Identifier

The identifier of the contact. It can be email_id (for EMAIL), phone_id (for SMS), or contact_id (for ID of the contact). This parameter is mandatory.

Type: String
Parameter Sets: (All)
Aliases: Id

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ListIds

Optional. The IDs of the contact list to which the contact is added.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-smsBlacklisted

Optional. Set/unset this field to blacklist/allow the contact for SMS.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-unlinkListIds

Optional. Ids of the lists to remove the contact from.

Type: Int32[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

The function returns the updated contact object.

NOTES

RELATED LINKS

[https://developers.brevo.com/reference/updatecontact https://developers.brevo.com/reference/updatebatchcontacts](https://developers.brevo.com/reference/updatecontact https://developers.brevo.com/reference/updatebatchcontacts)

https://developers.brevo.com/reference/updatecontact https://developers.brevo.com/reference/updatebatchcontacts

⚠️ **GitHub.com Fallback** ⚠️