Create a courier session

POST /app/courier/session
App key auth

Create a session to retrieve session information for other requests within the courier app. This session allows the courier to authenticate and access protected resources.

application/json

Body Required

  • userId string

    The ID of the user creating the session

Responses

  • 200 application/json

    Session created successfully

    Hide response attribute Show response attribute object
  • 401 application/json

    Unauthorized. The request is missing valid authentication credentials.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating lack of authorization
  • 400 application/json

    Bad Request. The request is malformed or missing required parameters.

    Hide response attribute Show response attribute object
    • error string

      Error message detailing the cause of the bad request
  • 500 application/json

    Internal Server Error. An unexpected error occurred on the server.

    Hide response attribute Show response attribute object
    • error string

      Error message indicating an internal server error
POST /app/courier/session 
curl \
 --request POST 'https://api.staging.glsnxt.com/ooh/carrier-connector/v1/app/courier/session' \
 --header "X-APP-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"userId":"courier123"}'
Request examples 
{
  "userId": "courier123"
}
Response examples (200) 
{
  "sessionToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
Response examples (401) 
{
  "error": "Unauthorized"
}
Response examples (400) 
{
  "error": "Invalid request. Check parameters and try again."
}
Response examples (500) 
{
  "error": "Internal Server Error"
}