Set up a connection to Royal Mail

Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

API version * 

Enter your Royal Mail account API version (v1, v2, or v3).

Auth type *

Select your Royal Mail account authentication type (either Custom or OAuth2.0).

Client secret *

Enter your Royal Mail client secret. 

​​ How to retrieve the client secret

API version: v1

Auth type: Custom

Client ID *

Enter your Royal Mail client ID. 

​​ How to retrieve the client ID

Client secret *

Enter your Royal Mail client secret.

​​ How to retrieve the client secret

Auth type: OAuth 2.0

Host address *

Enter your Royal Mail host address.

Org segment *

Enter your Royal Mail org segment.

OAuth 2.0 client *

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Royal Mail.

To add an OAuth 2.0 client and configure your credentials, click the plus (+) button. Click the edit () button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

​​ How to retrieve the client ID and secret

Username *

Enter your Royal Mail username.

Password *

Enter your Royal Mail password.

Multiple layers of protection, including AES 256 encryption, are in place to keep your password safe. When editing this connection, you must re-enter this value each time; it is stored only when the connection is saved and never displayed as text.

API version: v2

Mail piece ID *

Enter your Royal Mail piece ID.

RGM terms *

Enter your Royal Mail RGM terms.

Client ID *

Enter your Royal Mail client ID. 

​​ How to retrieve the client ID

API version: v3

Client ID *

Enter your Royal Mail client ID. 

​​How to retrieve the client ID