SmartMatchApp

Update Client List

Associate a client with a specific list.

This endpoint associates the specified client with a specific list. The association is made using the client_list parameter.

Example Request:
curl "https://<your-agency>.smartmatchapp.com/api3/clients/<client_id>/lists/" \
    -u <token>: \
    -X PUT \
    -F client_list=1
Form Fields:

client_list: The ID of the list to associate with the client. This field is required.

Example Success Response:
HTTP 204 No Content
Base Request:

Method: PUT

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

Rate Limits:

10 requests within 10 seconds

Error Responses:
400 Bad Request

If the client_list field is missing, error response will be "This field is required"
If the client_list field contains an invalid choice, error response will be "Select a valid choice. That choice is not one of the available choices"
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 or the specified list with the ID does not exist.
Possible errors: "object does not exist"
405 Method Not Allowed

This error occurs if an HTTP method other than PUT is used (e.g., POST or GET).
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"