API Reference · SmartMatchApp

Update Client Profile

Update the profile details associated with a specific client.

This endpoint allows for updating the profile of a specified client. Users can modify existing profile fields, add new data.

Example Request:

curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/profile/" \
  -u <token>: \
  -X PUT \
  -F prof_2=2 \
  -F prof_3_country="UK" \
  -F prof_4="short text" \
  -F prof_5=1 \
  -F prof_5=2

Form Fields:

Custom Fields:

prof_X: (Optional) The value for custom profile fields like prof_2, prof_3, etc., correspond to specific custom fields in the profile.

prof_X_country, prof_X_city, etc.: (Optional) Fields for updating Location type profile field. The field name schema follows prof_X_fieldname where fieldname corresponds to the specific location detail.

Example Success Response:

HTTP 204 No Content

Field Types:

The fields in the client profile are of various types, each having a specific structure:

Integer Number: A numerical field that contains an integer value.

Fractional Number: A numerical field that contains a floating-point value (a number with decimals).

Date: A field that contains a date value in the format YYYY-MM-DD.

Time: A field that contains a time value in the format HH:MM:SS.

Birthday (Age): A field that contains a date value representing a birthday in the format YYYY-MM-DD.

Height (cm - ft & in): A field that contains a numerical value representing height in millimeters. Choices are same as for "Retrieve Client Profile" endpoint.

Height (ft & in): A field that contains a numerical value representing height in feet and inches. Choices are same as for "Retrieve Client Profile" endpoint.

Weight (International): A field that contains a numerical value representing weight in grams. Choices are same as for "Retrieve Client Profile" endpoint.

Short Text, Long Text: A string containing the text value.

Yes/No: A boolean value (true or false).

MultiSelect: An integer number of existing choice. To add multiple values to a field, you must repeat same field name with different values.

Select: An integer number of existing choice.

Location: A valid part of location to change.

Web Link: A URL string.

File, Image: A file to upload.

PhoneNumber: A string representing a phone number.

Usage Example:

Replace Existing Profile Data:

curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/profile/" \
    -u <token>: \
    -X PUT \
    -F prof_1="Text" \
    -F prof_4='Updated short text'

This replaces the values for prof_1 and prof_4 with the new data provided.

Base Request:

Method: PUT

Authentication: Basic Authentication. Requires a valid <token> passed.

Rate Limits:

10 requests within 10 seconds

Error Responses:

400	Bad Request	This error occurs if the provided data is invalid. Possible errors: "Invalid email address", "Invalid value for this field", "Invalid date format"
401	Unauthorized	This error occurs when the <token> is missing, invalid, or the API access is disabled. Possible errors: "not authenticated" or "token is disabled" or "Agency API is disabled"
404	Not Found	This error occurs if the client with the specified ID does not exist. Possible errors: "client not found"
405	Method Not Allowed	This error occurs if an HTTP method other than PUT is used (e.g., GET or POST). Possible errors: "wrong method"
429	Too Many Requests	This error occurs when the client has sent too many requests in a given amount of time, leading to rate limiting by the server. Possible errors: "too many requests"
500	Server Error	Possible errors: "Internal server error"

Available Fields:

The field ids, labels, types, and available values below are generic samples. Every agency defines its own custom fields, so your agency's own live list appears in its private copy of these API docs.

Title	Name	Type
First Name	prof_1	Text
Country	prof_2	Select	Show Values 1: Example value A 2: Example value B