Skip to content

README.md

Latest commit

 

History

History
61 lines (43 loc) · 7.78 KB

README.md

File metadata and controls

61 lines (43 loc) · 7.78 KB

Contacts

Overview

Available Operations

  • create - Update user information

create

Update or add user information to workspace

Example Usage

from 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)

Parameters

Parameter Type Required Description Example
external_id str ✔️ 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. user_12345
display_name OptionalNullable[str] ➖ Display name or nickname of the contact user. This is typically shown in user interfaces. Jane Smith
email OptionalNullable[str] ➖ Email address of the contact user jane.smith@example.com
avatar_url OptionalNullable[str] ➖ URL linking to the contact user's avatar image https://example.com/avatars/jane-smith.jpg
tags List[str] ➖ Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications. [
"premium",
"beta-user",
"enterprise"
]
metadata Dict[str, Any] ➖ Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application. {
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium",
"last_login": "2024-01-15T10:30:00Z"
}
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateContactResponseBody

Errors

Error Type Status Code Content Type
models.APIError 4XX, 5XX */*