User Settings

Manage individual user profile and communication preferences.

This endpoint manages settings for individual users connected via a connect link — not API key owners themselves.

Endpoint

GET and POST https://api.warmai.uk/functions/v1/api-user-settings

Headers:

Header	Required	Description
`x-access-key`	Yes	Your API access key
`x-user-id`	Yes	The user’s ID

Get User Settings

Retrieve the current settings for a connected user.

Method: GET

Example Request:


curl -X GET "https://api.warmai.uk/functions/v1/api-user-settings" \
  -H "x-access-key: your_access_key" \
  -H "x-user-id: usr_abc123"

Response:


{
  "user_id": "usr_abc123",
  "first_name": "Jane",
  "last_name": "Doe",
  "calendar_link": "https://calendly.com/janedoe/30min",
  "cta_preference": "meeting",
  "custom_cta": null,
  "connection_request_with_note": true,
  "communication_style": "professional",
  "message_length": "moderate",
  "signature_style": "Best, Jane"
}

Update User Settings

Update one or more settings for a connected user. Only include the fields you want to change.

Method: POST

Example Request:


curl -X POST "https://api.warmai.uk/functions/v1/api-user-settings" \
  -H "x-access-key: your_access_key" \
  -H "x-user-id: usr_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "cta_preference": "call",
    "message_length": "brief"
  }'

Response:


{
  "success": true,
  "updated_fields": ["cta_preference", "message_length"]
}

Available Fields

Field	Type	Description
`first_name`	string	User’s first name
`last_name`	string	User’s last name
`calendar_link`	string	URL to the user’s scheduling page
`cta_preference`	string	Call-to-action type: `meeting`, `call`, `email`, `website`, `soft`, or `custom`
`custom_cta`	string	Custom CTA text (used when `cta_preference` is `custom`)
`connection_request_with_note`	boolean	Whether to include a note with LinkedIn connection requests
`communication_style`	string	Tone of outreach messages: `professional`, `casual`, or `consultative`
`message_length`	string	Message length preference: `brief`, `moderate`, `detailed`, `short`, `medium`, or `long`
`signature_style`	string	Sign-off text appended to messages

Error Responses

Status	Code	Description
400	Bad Request	Invalid fields provided in the request body
400	Bad Request	Empty request body on POST
401	Unauthorised	Missing `x-access-key` header
401	Unauthorised	Invalid or expired access key
403	Forbidden	User is not linked to this access key
403	Forbidden	User is not in an active state