V3 REFERENCE Account Settings

/myprofile

Manage user profile data such as address, payment information etc.

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

# list myprofile resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/myprofile
Properties
Name Description
AddressCity City part of address.
  • [ Type AnsiString ]
AddressCountry Country part of address.
  • [ Type AnsiString ]
AddressPostalCode Postal code of address (ZIP).
  • [ Type AnsiString ]
AddressState State part of the address. Aplicable only for US.
  • [ Type AnsiString ]
AddressStreet Street and house number.
  • [ Type AnsiString ]
BillingEmail Billing email address.
  • [ Type TBillingEmail ]
BirthdayAt User's birthday.
  • [ Type TRFC3339DateTime ]
CompanyName Name of the company.
  • [ Type AnsiString ]
CompanyNumOfEmployees The number of employees in the company.
  • [ Type AnsiString ]
ContactPhone Contact telephone.
  • [ Type AnsiString ]
EstimatedVolume Estimated volume of messages.
  • [ Type LongInt ]
Features ?.
  • [ Type AnsiString ]
Firstname Contact person's first name.
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
Industry Industry in which user works.
  • [ Type AnsiString ]
JobTitle Contact person's job title.
  • [ Type AnsiString ]
Lastname Contact person's last name.
  • [ Type AnsiString ]
UserID
OR
UserALT
UserID
ID reference to User
UserALT
Value of the Email field of the related User resource
  • [ Type TUser ]
VAT VAT rate for this user.
  • Read Only
  • [ Type Currency ]
VATNumber User supplied VAT number.
  • [ Type AnsiString ]
Website URL of user's website.
  • [ Type AnsiString ]
Filters
Name Description
User Only retrieve myprofile resources for which User equals the specified value.
  • [ Type Int64 ]

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

# access the myprofile resource identified by $ID

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

    
    
Properties
Name Description
AddressCity City part of address.
  • [ Type AnsiString ]
AddressCountry Country part of address.
  • [ Type AnsiString ]
AddressPostalCode Postal code of address (ZIP).
  • [ Type AnsiString ]
AddressState State part of the address. Aplicable only for US.
  • [ Type AnsiString ]
AddressStreet Street and house number.
  • [ Type AnsiString ]
BillingEmail Billing email address.
  • [ Type TBillingEmail ]
BirthdayAt User's birthday.
  • [ Type TRFC3339DateTime ]
CompanyName Name of the company.
  • [ Type AnsiString ]
CompanyNumOfEmployees The number of employees in the company.
  • [ Type AnsiString ]
ContactPhone Contact telephone.
  • [ Type AnsiString ]
EstimatedVolume Estimated volume of messages.
  • [ Type LongInt ]
Features ?.
  • [ Type AnsiString ]
Firstname Contact person's first name.
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
Industry Industry in which user works.
  • [ Type AnsiString ]
JobTitle Contact person's job title.
  • [ Type AnsiString ]
Lastname Contact person's last name.
  • [ Type AnsiString ]
UserID
OR
UserALT
UserID
ID reference to User
UserALT
Value of the Email field of the related User resource
  • [ Type TUser ]
VAT VAT rate for this user.
  • Read Only
  • [ Type Currency ]
VATNumber User supplied VAT number.
  • [ Type AnsiString ]
Website URL of user's website.
  • [ Type AnsiString ]

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

# update content of resource myprofile identified by ID $ID

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

    
Properties
Name Description
AddressCity City part of address.
  • [ Type AnsiString ]
AddressCountry Country part of address.
  • [ Type AnsiString ]
AddressPostalCode Postal code of address (ZIP).
  • [ Type AnsiString ]
AddressState State part of the address. Aplicable only for US.
  • [ Type AnsiString ]
AddressStreet Street and house number.
  • [ Type AnsiString ]
BillingEmail Billing email address.
  • [ Type TBillingEmail ]
BirthdayAt User's birthday.
  • [ Type TRFC3339DateTime ]
CompanyName Name of the company.
  • [ Type AnsiString ]
CompanyNumOfEmployees The number of employees in the company.
  • [ Type AnsiString ]
ContactPhone Contact telephone.
  • [ Type AnsiString ]
EstimatedVolume Estimated volume of messages.
  • [ Type LongInt ]
Features ?.
  • [ Type AnsiString ]
Firstname Contact person's first name.
  • [ Type AnsiString ]
ID Unique numerical ID for this object.
  • Read Only
  • [ Type Int64 ]
Industry Industry in which user works.
  • [ Type AnsiString ]
JobTitle Contact person's job title.
  • [ Type AnsiString ]
Lastname Contact person's last name.
  • [ Type AnsiString ]
UserID
OR
UserALT
UserID
ID reference to User
UserALT
Value of the Email field of the related User resource
  • [ Type TUser ]
VAT VAT rate for this user.
  • Read Only
  • [ Type Currency ]
VATNumber User supplied VAT number.
  • [ Type AnsiString ]
Website URL of user's website.
  • [ Type AnsiString ]