Contact Method
A Contact Method represents a communication channel such as an email address or phone number owned by either a person or an organization. Each contact method has a type (EMAIL or PHONE) and a kind (BUSINESS or PERSONAL). A single contact method can be designated as the primary contact for its owner, which updates the owner’s primary_contact_method_id pointer.
Sample Object
{
"id": "cnt_mno345pqr678",
"owner_id": "ppl_abc123def456",
"contact_type": "EMAIL",
"contact_kind": "PERSONAL",
"value": "jane.doe@example.com"
}Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the contact method. Auto-generated on create. |
owner_id | string | ID of the person or organization that owns this contact method. |
contact_type | enum | Type of contact. One of EMAIL or PHONE. |
contact_kind | enum | Usage context. One of BUSINESS or PERSONAL. |
value | string | The email address or phone number. |
primary | boolean | When set to true on create or update, this contact method becomes the owner’s primary contact. |
Actions
Person
Adding a contact method
Adds a new contact method to a person. When the primary flag is set to true, the person’s primary_contact_method_id is updated.
obx app identity:people:contacts init
obx app identity:people:contacts push init --person-id ppl_abc123def456Listing contact methods
Returns all contact methods owned by a specific person.
obx app identity:people:contacts list --person-id ppl_abc123def456Getting a contact method
Returns a specific contact method by its ID within the context of the person owner.
obx app identity:people:contacts pull cnt_mno345pqr678 --person-id ppl_abc123def456Updating a contact method
Updates the fields of a contact method. Set primary to true to promote this method as the person’s primary contact.
obx app identity:people:contacts push cnt_mno345pqr678 --person-id ppl_abc123def456Deleting a contact method
Removes a contact method from the person. If the deleted method was the primary contact, the person’s primary_contact_method_id is set to null.
obx app identity:people:contacts delete cnt_mno345pqr678 --person-id ppl_abc123def456Deleting all contact methods
Removes every contact method owned by the person in a single operation.
obx app identity:people:contacts delete-all --person-id ppl_abc123def456Organization
Adding a contact method
Adds a new contact method to an organization. When the primary flag is set to true, the organization’s primary_contact_method_id is updated.
obx app identity:organizations:contacts init
obx app identity:organizations:contacts push init --org-id org_abc123def456Listing contact methods
Returns all contact methods owned by a specific organization.
obx app identity:organizations:contacts list --org-id org_abc123def456Getting a contact method
Returns a specific contact method by its ID within the context of the organization owner.
obx app identity:organizations:contacts pull cnt_mno345pqr678 --org-id org_abc123def456Updating a contact method
Updates the fields of a contact method. Set primary to true to promote this method as the organization’s primary contact.
obx app identity:organizations:contacts push cnt_mno345pqr678 --org-id org_abc123def456Deleting a contact method
Removes a contact method from the organization. If the deleted method was the primary contact, the organization’s primary_contact_method_id is set to null.
obx app identity:organizations:contacts delete cnt_mno345pqr678 --org-id org_abc123def456Deleting all contact methods
Removes every contact method owned by the organization in a single operation.
obx app identity:organizations:contacts delete-all --org-id org_abc123def456