Rvops icon

Rvops

Integração Rvops

Overview

The "Add Contacts to Segment" operation in the Segment resource allows users to add multiple contacts to a specific segment by providing the segment ID and a list of contact IDs. This is useful for managing groups of contacts within a marketing or CRM system, enabling targeted communication or segmentation based on various criteria.

Common scenarios include:

  • Bulk adding selected contacts to a marketing segment for campaign targeting.
  • Organizing contacts into segments dynamically based on workflow conditions.
  • Synchronizing external contact lists with internal segmentation structures.

For example, you might have a segment representing "Newsletter Subscribers" and want to add a batch of new contacts who signed up recently to this segment using this operation.

Properties

Name Meaning
Autenticação Do Cliente Authentication method; currently supports "Access Token".
ID Do Segmento The unique numeric identifier of the segment to which contacts will be added (required).
Adicionar Contatos Ao Segmento A collection of filters specifying the contacts to add. Each filter requires the contact's ID.

Details on "Adicionar Contatos Ao Segmento"

  • It is a fixed collection allowing multiple values.
  • Each entry under "Filters" must specify an "ID Do Contato" (Contact ID) as a number greater than or equal to 1.
  • These contact IDs are collected and sent as the list of contacts to add to the segment.

Output

The output JSON contains the response from the API after attempting to add the contacts to the segment. Typically, it includes confirmation details such as the segment ID and the list of contacts added or any relevant status information returned by the API.

The node does not explicitly handle binary data for this operation.

Dependencies

  • Requires an API key credential for authentication (referred generically as an API access token).
  • Depends on the external service's API endpoint that manages segments and contacts.
  • The node uses HTTP POST requests to the endpoint segments/{segmentId}/add with a payload containing the contact IDs.

Troubleshooting

  • Invalid Segment ID: If the provided segment ID does not exist or is invalid, the API may return an error. Verify the segment ID before running the node.
  • Invalid Contact IDs: Providing contact IDs that do not exist or are malformed will cause the operation to fail or ignore those contacts. Ensure all contact IDs are valid numbers corresponding to existing contacts.
  • Authentication Errors: If the access token is missing, expired, or incorrect, the API will reject the request. Confirm that the API key credential is correctly configured.
  • Empty Contact List: Sending an empty list of contacts may result in no action or an error. Make sure at least one contact ID is specified.
  • API Rate Limits: Adding many contacts at once might hit rate limits imposed by the external service. Consider batching large lists if errors occur.

Error messages typically include HTTP status codes and descriptive messages from the API, which should guide corrective actions.

Links and References

  • Refer to the external service's official API documentation for segments and contacts management for detailed behavior and additional options.
  • n8n documentation on creating and configuring credentials for API authentication.
  • General best practices for handling bulk operations and API rate limiting.

Discussion