V3 REFERENCE Account Settings

/user

User account definition for Mailjet.

List user resources available for this apikey, use a GET request. Alternatively, you may want to add one or more filters.

# list user resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/user
Unique Key

In addition to the resource $ID, you can also use the unique key $Email to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
ACL (AnsiString)
  • [ Type AnsiString ]
CreatedAt Timestamp when object was created in database.
  • Read Only
  • [ Type TRFC3339DateTime ]
Email Email address of user.
  • Unique
  • [ Type TEmail ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
LastIp IP address of last contact from user.
  • Mandatory
  • [ Type AnsiString ]
LastLoginAt Timestamp when user last logged in.
  • [ Type TRFC3339DateTime ]
Locale Locale in which the information in this record is recorded.
  • [ Type AnsiString ]
MaxAllowedAPIKeys Maximum number of API keys the user is allowed to have.
  • Read Only
  • [ Type LongInt ]
Timezone Timezone for this user.
  • [ Type AnsiString ]
Username User name.
  • Mandatory
  • [ Type AnsiString ]
WarnedRatelimitAt Timestamp when user was last warned about hitting his rate limit.
  • [ Type TRFC3339DateTime ]
Filters
Name Description
IsActivated Only retrieve user resources for which IsActivated equals the specified value.
  • [ Type TBooleanFilter ]
NewEmail Only retrieve user resources for which NewEmail equals the specified value.
  • [ Type AnsiString ]
UserName Only retrieve users where Username matches the specified value.
  • [ Type AnsiString ]

Access a given user resource, use a GET request, providing the user's ID value.

# access the user resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/user/$ID

    
# access the resource through the Email's value
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/user/$Email
    
    
Unique Key

In addition to the resource $ID, you can also use the unique key $Email to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
ACL (AnsiString)
  • [ Type AnsiString ]
CreatedAt Timestamp when object was created in database.
  • Read Only
  • [ Type TRFC3339DateTime ]
Email Email address of user.
  • Unique
  • [ Type TEmail ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
LastIp IP address of last contact from user.
  • Mandatory
  • [ Type AnsiString ]
LastLoginAt Timestamp when user last logged in.
  • [ Type TRFC3339DateTime ]
Locale Locale in which the information in this record is recorded.
  • [ Type AnsiString ]
MaxAllowedAPIKeys Maximum number of API keys the user is allowed to have.
  • Read Only
  • [ Type LongInt ]
Timezone Timezone for this user.
  • [ Type AnsiString ]
Username User name.
  • Mandatory
  • [ Type AnsiString ]
WarnedRatelimitAt Timestamp when user was last warned about hitting his rate limit.
  • [ Type TRFC3339DateTime ]

Update one specific user resource with a PUT request, providing the user's ID value. Be sure to include all the mandatory properties.

# update content of resource user identified by ID $ID

curl -s -X PUT \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/user/$ID \
-H 'Content-Type: application/json' \
-d '{"ACL": ...}'

    
# update the content, using the value of the Email property
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X PUT \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/user/:Email \
-H 'Content-Type: application/json' \
-d '{"ACL": ...}'
    
Unique Key

In addition to the resource $ID, you can also use the unique key $Email to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
ACL (AnsiString)
  • [ Type AnsiString ]
CreatedAt Timestamp when object was created in database.
  • Read Only
  • [ Type TRFC3339DateTime ]
Email Email address of user.
  • Unique
  • [ Type TEmail ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
LastIp IP address of last contact from user.
  • Mandatory
  • [ Type AnsiString ]
LastLoginAt Timestamp when user last logged in.
  • [ Type TRFC3339DateTime ]
Locale Locale in which the information in this record is recorded.
  • [ Type AnsiString ]
MaxAllowedAPIKeys Maximum number of API keys the user is allowed to have.
  • Read Only
  • [ Type LongInt ]
Timezone Timezone for this user.
  • [ Type AnsiString ]
Username User name.
  • Mandatory
  • [ Type AnsiString ]
WarnedRatelimitAt Timestamp when user was last warned about hitting his rate limit.
  • [ Type TRFC3339DateTime ]