# Customers

The customers endpoint allows you to create, update or search for customers through various parameters depending on your configuration.

Depending on your configuration, the API may take or return additional fields in the extendedProperties object. 

To get an example of your specific integration, please contact our support team.


## Get customer by mobile phone

 - [GET /customers](https://dev.triggloyalty.com/openapi/customers/getcustomerbymobilephone.md): This method allows the client to search for a customer by a mobile phone number.

Example: +4712345678

The response sample below shows the default response, but depending on your configuration the API may return additional fields in the extendedProperties object.

## Create customer

 - [POST /customers](https://dev.triggloyalty.com/openapi/customers/createmember.md): The request sample(s) below shows the default payload and one minimum required payload. 

Depending on your configuration, the API may take or return additional fields in the extendedProperties object. For specific examples reach out to your technical contact.

## Update customer

 - [PUT /customers](https://dev.triggloyalty.com/openapi/customers/updatemember.md): The request sample(s) below shows the default payload and one minimum required payload. 

Depending on your configuration, the API may take or return additional fields in the extendedProperties object. For specific examples reach out to your technical contact.

## Update customer by external id

 - [PUT /customers/externalId](https://dev.triggloyalty.com/openapi/customers/updatecustomerbyexternalid.md): The request sample(s) below shows the default payload and one minimum required payload. 

Depending on your configuration, the API may take or return additional fields in the extendedProperties object. For specific examples reach out to your technical contact.

## Get customer by id

 - [GET /customers/id/{id}](https://dev.triggloyalty.com/openapi/customers/getcustomerbyid.md): This method allows the client to search for a customer by a unique id

Example: 226B14AF-18A6-44CF-834E-BE4BCA5D64B7

The response sample below shows the default response, but depending on your configuration the API may return additional fields in the extendedProperties object.

## Get customer by external id

 - [GET /customers/externalId/{id}](https://dev.triggloyalty.com/openapi/customers/getcustomerbyexternalid.md): This method allows the client to search for a customer by an external Id

Example: B9012E40-1B08-4DC5-84F9-BB8E2653B2A6

The response sample below shows the default response, but depending on your configuration the API may return additional fields in the extendedProperties object.

## Get changed customers

 - [GET /customers/changed/{timestamp}](https://dev.triggloyalty.com/openapi/customers/getchangedcustomerslist.md): Returns a list of changed customers since given timestamp. Default (empty parameter) is since last day.

## Delete customer

 - [DELETE /customers/id/{id}/source/{source}](https://dev.triggloyalty.com/openapi/customers/deletemember.md): Method that let's you delete a customer by Id

## Delete customer by external id

 - [DELETE /customers/externalId/{externalId}/source/{source}](https://dev.triggloyalty.com/openapi/customers/deletememberbyexternalid.md): Method that let's you delete a customer by an external id

## Get customer by email [PREVIEW]

 - [GET /customers/email/{email}](https://dev.triggloyalty.com/openapi/customers/getcustomerbyemail.md): This method allows the client to search for a customer by email address

Note: Special characters such as '+'' must be encoded. Example: +=%2B

The response sample below shows the default response, but depending on your configuration the API may return additional fields in the extendedProperties object.

## Create prospect [PREVIEW ]

 - [POST /customers/prospects](https://dev.triggloyalty.com/openapi/customers/createprospect.md): This endpoint creates a new customer prospect record in the system. It accepts either email or mobilePhone in the request body and returns the created customer id upon success.         

Depending on your configuration, the API may take or return additional fields in the extendedProperties object. For specific examples reach out to your technical contact.

## Dynamic method

 - [POST /customers/dynamic/{function}](https://dev.triggloyalty.com/openapi/customers/postcustomerdynamic.md): This method is fully dynamic both in request/response and is available for specific client customizations on the customer endpoint.