--- title: "Patch an API key" method: PATCH path: "/api_keys/edit" tags: ["API KEYS"] --- # Patch an API key `PATCH /api_keys/edit` Patch an existing API key ignoring missing properties ## Request body - object - `id` string, required — The ID of the existing API key you wish to edit. - `description` string — A comment or description of your new API key - `custom_ratelimit` boolean — If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period. - `custom_ratelimit_value` integer — If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period.

Note: Only stores this value if custom_ratelimit is true. - `custom_ratelimit_period` string — If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value.

Syntax: "\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".

Examples: "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".

Note: Only stores this value if custom_ratelimit is true. - `ip_pool` integer — If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint. - `feedback_enabled` boolean — If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings. - `feedback_html` string — The HTML content to insert into the custom feedback email body via the unsubscribe footer.

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%

- `feedback_text` string — The text content to insert into the custom feedback email body via the unsubscribe footer.

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%

- `open_tracking_enabled` boolean — If true, open tracking will be enabled for this API key. - `click_tracking_enabled` boolean — If true, click tracking will be enabled for this API key. - `archive_enabled` boolean — If true, archiving (available on paid plans) will be enabled for this API key. - `audit_email` string — If passed, this email will be BCC'd on all emails sent by this API key. - `bounce_notifications` string — If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account. - `status` string — The initial status of the API key, one of ['allowed', 'blocked', 'sandbox']. - `endpoints` string[] — An array of endpoints that this API key will be allowed to use.

Any additional endpoints passed must be a subset of the endpoints allowed by the API key making this call.

A full list of endpoints can be found in the app under Sending->API Keys->Permissions or programatically via the API here.

We also accept wildcard patterns, for example to allow access to all email endpoints you can pass ["/email/*"].

To allow access to every endpoint simply pass "endpoints": ["*"] - `subaccount_id` string — If you wish to make this API call on behalf of a subaccount then include its unique ID here. ## Response `200` Successfully patched API key - object - `data` object[], required — An array of API key results - `request_id` string, required - `data` object, required - `api_key` string — The API key used to query the API (masked) - `username` string — A shortened version of the API key which can be used to correlate data with some other API calls that also feature username. - `description` string — A comment or description of the API key. - `custom_rate_limit` boolean — If enabled will use the values of custom_ratelimit_value and custom_ratelimit_period for rate limiting. - `custom_ratelimit_value` integer — If passed, defines the limit of emails this API key can send in the period specified in custom_ratelimit_period. - `custom_ratelimit_period` string — If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value.

Syntax: "\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".

Examples: "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".

Note: Only stores this value if custom_ratelimit is true. - `default_ratelimit_value` string — The default limit of emails this API key can send in the period specified in default_ratelimit_period. Note: Used if custom_ratelimit is false. - `default_ratelimit_period` string — The default period for which this API key will be limited to the number of emails specified in default_ratelimit_value.

Syntax: "\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".

Examples: "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".

Note: Used if custom_ratelimit is false. - `ippool` integer - `feedback_enabled` boolean — If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings. - `feedback_html` string — The HTML content to insert into the custom feedback email body via the unsubscribe footer. Default: blank

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%

- `feedback_text` string — The text content to insert into the custom feedback email body via the unsubscribe footer. Default: blank

System Variables (Only available here):

Unsubscribe URL = %%UNSUBSCRIBE%%
Email address = %%EMAIL%%