User update
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.
User’s name.
User’s email address.
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.
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.
Type of budget duration. Possible values are daily
, weekly
, monthly
, and yearly
. The default value is monthly
.
The budget amount for the period. The default value is null
, which means no budget is set.
Customized metadata for the user. Any key-value pairs can be added here.