Contacts
Create a Contact
Update or add user information to workspacefrom orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.contacts.create(external_id="user_12345", display_name="Jane Smith", email="jane.smith@example.com", avatar_url="https://example.com/avatars/jane-smith.jpg", tags=[
"premium",
"beta-user",
"enterprise",
], metadata={
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium",
"last_login": "2024-01-15T10:30:00Z",
})
# Handle response
print(res)
Show Parameters
Show Parameters
Unique string value to identify the contact user in the customer’s system. This should be the same ID you use in your system to reference this user.
Display name or nickname of the contact user. This is typically shown in user interfaces.
Email address of the contact user
URL linking to the contact user’s avatar image
Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
Show Response
Show Response
Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
Unique string value to identify the contact user in the customer’s system. This should be the same ID you use in your system to reference this user.
Display name or nickname of the contact user. This is typically shown in user interfaces.
Email address of the contact user
URL linking to the contact user’s avatar image
Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
The date and time the resource was created