Skip to main content
PUT
/
api_keys
/
{api_key_id}
Update API keys
curl --request PUT \
  --url https://api.partoo.co/v2/api_keys/{api_key_id} \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '{
  "label": "API key name",
  "expiration_date": "2022-06-05",
  "ip_whitelist": [
    "172.16.0.0/12",
    "127.0.0.1"
  ]
}'
{
  "id": 3245,
  "label": "API key name",
  "user_id": "5309c3a237bbc544d8e26737",
  "user_name": "Perceval de Galles",
  "user_role": "BUSINESS_MANAGER",
  "disabled": false,
  "expiration_date": "2022-06-05",
  "last_used_at": "2019-08-22 11:46:38.914467+00",
  "created_by": "5309c3a237bbc544d8e26737",
  "created_by_name": "John Smith",
  "created_at": "2018-03-12 11:49:03.399475+00",
  "revoked_by": "5309c3a237bbc544d8e26737",
  "revoked_by_name": "John Smith",
  "revoked_at": "2020-10-20 11:46:38.914467+00",
  "ip_whitelist": [
    "172.16.0.0/12",
    "127.0.0.1"
  ]
}

Authorizations

​
x-APIKey
string
header
required

The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.

Path Parameters

​
api_key_id
integer
required

Key ID

Example:

3245

Body

application/json
​
label
string

Name given to recognize the Api key

Example:

"API key name"

​
expiration_date
string

Must be at least the day after today. If you want it to expire today you must revoke it. You can set it to null.

Example:

"2022-06-05"

​
ip_whitelist
string[]

List of IP or CIDR network notations to which API Key calls are restricted.

Empty list means no restriction.

Example:
["172.16.0.0/12", "127.0.0.1"]

Response

OK

​
id
integer
Example:

3245

​
label
string

Name given to recognize the Api key

Example:

"API key name"

​
user_id
string

User id

Example:

"5309c3a237bbc544d8e26737"

​
user_name
string

User first name and last name concatenated. Can be null if it's your org integration api key.

Example:

"Perceval de Galles"

​
user_role
enum<string>

User role in the application

Available options:
PROVIDER,
ORG_ADMIN,
GROUP_MANAGER,
BUSINESS_MANAGER,
PUBLISHER
Example:

"BUSINESS_MANAGER"

​
disabled
boolean

Is true if someone revoked the key.

Example:

false

​
expiration_date
string

Must be at least the day after today. If you want it to expire today you must revoke it. You can set it to null.

Example:

"2022-06-05"

​
last_used_at
string
Example:

"2019-08-22 11:46:38.914467+00"

​
created_by
string

User id

Example:

"5309c3a237bbc544d8e26737"

​
created_by_name
string

First name and last name concatenated of the user that created the key

Example:

"John Smith"

​
created_at
string
Example:

"2018-03-12 11:49:03.399475+00"

​
revoked_by
string

User id

Example:

"5309c3a237bbc544d8e26737"

​
revoked_by_name
string

First name and last name concatenated of the user that revoked the key

Example:

"John Smith"

​
revoked_at
string
Example:

"2020-10-20 11:46:38.914467+00"

​
ip_whitelist
string[]

List of IP or CIDR network notations to which API Key calls are restricted.

Empty list means no restriction.

Example:
["172.16.0.0/12", "127.0.0.1"]