V3 REFERENCE Parse API

/parseroute

ParseRoute description

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

# list parseroute resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/parseroute
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
APIKeyID
OR
APIKeyALT
APIKeyID
ID reference to APIKey
APIKeyALT
Value of the APIKey field of the related APIKey resource
  • Mandatory
  • [ Type TAPIKey ]
Email Email address
  • Mandatory
  • Unique
  • [ Type TEmail ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Url URL address
  • Mandatory
  • [ Type AnsiString ]
Filters
Name Description
APIKey Only retrieve parseroute resources for which APIKey ID equals the specified value.
  • [ Type Int64 ]

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

# access the parseroute resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/parseroute/$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/parseroute/$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
APIKeyID
OR
APIKeyALT
APIKeyID
ID reference to APIKey
APIKeyALT
Value of the APIKey field of the related APIKey resource
  • Mandatory
  • [ Type TAPIKey ]
Email Email address
  • Mandatory
  • Unique
  • [ Type TEmail ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Url URL address
  • Mandatory
  • [ Type AnsiString ]

Add a new parseroute resource with a POST request.

# add a new parseroute resource, beware of the Read Only fields!

curl -s -X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/parseroute \
-H 'Content-Type: application/json' \
-d '{"APIKey": ...}'
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
APIKeyID
OR
APIKeyALT
APIKeyID
ID reference to APIKey
APIKeyALT
Value of the APIKey field of the related APIKey resource
  • Mandatory
  • [ Type TAPIKey ]
Email Email address
  • Mandatory
  • Unique
  • [ Type TEmail ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Url URL address
  • Mandatory
  • [ Type AnsiString ]

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

# update content of resource parseroute identified by ID $ID

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

    
# 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/parseroute/:Email \
-H 'Content-Type: application/json' \
-d '{"APIKey": ...}'
    
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
APIKeyID
OR
APIKeyALT
APIKeyID
ID reference to APIKey
APIKeyALT
Value of the APIKey field of the related APIKey resource
  • Mandatory
  • [ Type TAPIKey ]
Email Email address
  • Mandatory
  • Unique
  • [ Type TEmail ]
ID Unique ID of the object
  • Read Only
  • [ Type Int64 ]
Url URL address
  • Mandatory
  • [ Type AnsiString ]

Remove one given parseroute resource with a DELETE request, providing the parseroute's ID value.

# delete resource parseroute with ID $ID

curl -s -X DELETE \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/parseroute/$ID
    
# delete the resource using the alternate unique key Email
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X DELETE \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/parseroute/: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.