PATCH
/
api
/
user
/
update
/
<str:customer_identifier>

User update endpoint allows you to update user information, and set budgets and limits for a specific user.

Make sure to replace YOUR_KEYWORDSAI_API_KEY with your actual Keywords AI API key, and <str:customer_identifier> with the actual customer identifier.

name
string

User’s name.

email
string

User’s email address.

period_start
string

The start of the budget period in ISO Format: YYYY-MM-DD (e.g. 2024-03-09). If not provided, the current date will be used.

This field will automatically roll over to the next period if the current date is past the end of the period.

period_end
string

The end of the budget period in ISO Format: YYYY-MM-DD (e.g. 2024-03-09). If not provided, it will be set based on the period_start + budget_duration. (e.g. 2024-03-09 + 1 month = 2024-04-09)

This field will automatically roll over to the next period if the current date is past the end of the period.

budget_duration
string

Type of budget duration. Possible values are daily, weekly, monthly, and yearly. The default value is monthly.

period_budget
number

The budget amount for the period. The default value is null, which means no budget is set.

metadata
object

Customized metadata for the user. Any key-value pairs can be added here.