Skip to content

RestEContact.md

Latest commit

 

History

History
32 lines (26 loc) · 2.15 KB

RestEContact.md

File metadata and controls

32 lines (26 loc) · 2.15 KB
Raw

SendX::RestEContact

Properties

Name Type Description Notes
first_name String First name of the contact [optional]
last_name String Last name of the contact [optional]
email String Email address of the contact (required and must be unique within team). Validation: - Must be a valid email format - Must be unique within the team - Cannot be empty or null
company String Company name of the contact [optional]
custom_fields Hash<String, String> Custom fields as key-value pairs. Keys should use `field_` prefix. Processing: - Keys are case-sensitive - Values are stored as strings Examples: - `&quot;field_MnuqBAG2NPLm7PZMWbjQxt&quot;: &quot;Engineering&quot;` → stored as `department: Engineering` [optional]
lists Array<String> Array of list identifiers to associate with the contact. Identifiers should use `list_` prefix. Processing: - Invalid list IDs will send our 400 error - Duplicates will be removed Examples: - `&quot;list_OcuxJHdiAvujmwQVJfd3ss&quot;` → valid prefixed format [optional]
tags Array<String> Array of tag identifiers to associate with the contact. Identifiers should use `tag_` prefix. Processing: - Invalid tag IDs will be ignored - Duplicates will be removed Examples: - `&quot;tag_UhsDkjL772Qbj5lWtT62VK&quot;` → valid prefixed format [optional]
last_tracked_ip String Last tracked IP address of the contact for analytics purposes. Usage: - Used for geographic analytics - Helps with spam detection - Optional field [optional]

Example

require 'sendx-ruby-sdk'

instance = SendX::RestEContact.new(
  first_name: John,
  last_name: Doe,
  email: john.doe@example.com,
  company: Example Corp,
  custom_fields: {field_MnuqBAG2NPLm7PZMWbjQxt&#x3D;Engineering, field_QqfhckbdcvQinLPlduIbHq&#x3D;Senior},
  lists: [list_OcuxJHdiAvujmwQVJfd3ss],
  tags: [tag_UhsDkjL772Qbj5lWtT62VK],
  last_tracked_ip: 192.168.1.100
)