Customers

Retrieve a customer contact

Retrieves the customer contact with the given ID.

get/admin/customers/customer-contacts/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer-contacts/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired customer contact.

Response

idnumber required

Contact row ID.

customer_idnumber required

Owning customer (or lead) ID.

contact_person_idnumber nullable

Optional link to a contact person row.

contact_typestring required

Contact type: email or phone.

contact_valuestring required

Email address or phone number.

labelstring

Contact label.

country_codestring nullable

ISO 3166-1 alpha-2 country code (phone rows only).

is_primarystring

1 for the primary contact in its (customer_id, contact_type, label) tuple, otherwise 0.

is_whatsappstring

1 when the phone is flagged as WhatsApp-enabled, otherwise 0.

metadataobject nullable

Free-form JSON metadata, or null.

created_atstring

Row creation datetime.

updated_atstring

Row last-update datetime.

Example response

{
  "id": 1,
  "customer_id": 1,
  "contact_type": "email",
  "contact_value": "alpha@example.com",
  "label": "primary",
  "is_primary": "1"
}

Changes

No recorded changes to this operation across all 1 revision of this API.