curl --request POST \
--url https://api.orq.ai/v2/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_id": "user_12345",
"display_name": "Jane Smith",
"email": "[email protected]",
"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"
}
}
'{
"_id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"external_id": "user_12345",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"display_name": "Jane Smith",
"email": "[email protected]",
"avatar_url": "https://example.com/avatars/jane-smith.jpg",
"tags": [
"premium",
"beta-user"
],
"metadata": {
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium"
},
"created": "2024-01-15T10:30:00Z",
"updated": "2024-01-15T10:30:00Z"
}Create a contact
Creates a new contact with a unique external_id. If a contact with the same external_id already exists, the operation will fail. Use this endpoint to add users from your system to orq.ai for tracking their usage and engagement.
curl --request POST \
--url https://api.orq.ai/v2/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"external_id": "user_12345",
"display_name": "Jane Smith",
"email": "[email protected]",
"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"
}
}
'{
"_id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
"external_id": "user_12345",
"workspace_id": "550e8400-e29b-41d4-a716-446655440000",
"display_name": "Jane Smith",
"email": "[email protected]",
"avatar_url": "https://example.com/avatars/jane-smith.jpg",
"tags": [
"premium",
"beta-user"
],
"metadata": {
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium"
},
"created": "2024-01-15T10:30:00Z",
"updated": "2024-01-15T10:30:00Z"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Contact profile information
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.
1 - 120"user_12345"
Display name or nickname of the contact user. This is typically shown in user interfaces.
"Jane Smith"
Email address of the contact user
URL linking to the contact user's avatar image
"https://example.com/avatars/jane-smith.jpg"
Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
["premium", "beta-user", "enterprise"]
Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
Show child attributes
Show child attributes
{
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium",
"last_login": "2024-01-15T10:30:00Z"
}
Response
Created Contact
Unique ULID (Universally Unique Lexicographically Sortable Identifier) for the contact
"contact_01ARZ3NDEKTSV4RRFFQ69G5FAV"
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.
1 - 120"user_12345"
Unique identifier for the workspace to which the contact belongs
"550e8400-e29b-41d4-a716-446655440000"
Display name or nickname of the contact user. This is typically shown in user interfaces.
"Jane Smith"
Email address of the contact user
URL linking to the contact user's avatar image
"https://example.com/avatars/jane-smith.jpg"
Array of tags associated with the contact. Useful for organizing and filtering contacts by categories, departments, or custom classifications.
["premium", "beta-user", "enterprise"]
Additional custom metadata associated with the contact as key-value pairs. Use this to store any extra information specific to your application.
Show child attributes
Show child attributes
{
"department": "Engineering",
"role": "Senior Developer",
"subscription_tier": "premium",
"last_login": "2024-01-15T10:30:00Z"
}
The date and time the resource was created
The date and time the resource was last updated
Was this page helpful?