StarsenderInstall

Summary

Add a member to a specified campaign.

Inputs

• authHeaderName (required) — Choose the header name to send the API key (Authorization, X-API-KEY, or a custom name).
• authHeaderCustom — Custom header name used when Auth Header Name is set to Other.
• campaignId (required) — The ID of the campaign to which the member will be added.
• campaignMemberNumber (required) — The number of the member being added to the campaign.
• campaignMemberSyntax — The syntax for the member being added.
• campaignMemberWelcome — Indicates if a welcome message should be sent to the member.

Output shape

a response object indicating the success or failure of the member addition

Checks for required parameters and handles errors according to the API response.

Examples

Example 1: Adding a new member to an existing campaign using default header name.

Set campaignId to 123, campaignMemberNumber to '9876543210', and campaignMemberWelcome to true.

Example 2: Adding a member with a custom authorization header.

Set authHeaderName to 'Other' and authHeaderCustom to 'My-Custom-Header', along with campaignId and campaignMemberNumber.