v1

latestSwagger 2.02026-07-144713.2 KB
Sessions

Logs in a customer and obtains an authentication ticket.

Logs in a customer by obtaining an authentication ticket. It can then be used directly with the other William Hill APIs to access a customer’s sportsbook account, place a bet, etc.

post/tickets

Query parameters

fieldsstring[]

Specify an absolute field list to return (Comma Separated List)

includestring[]

Specify fields in addition to the default to return (Comma Separated List)

excludestring[]

Specify fields from the default to exclude (Comma Separated List)

languageAsPerTerritorystring

Defines response field name language, true (default) returns in language defined by territory, false returns in English

Headers

apiKeystring required

A unique identifier of your application that is generated by the API portal.

apiSecretstring required

Another unique identifier for your application.

territorystring

Territory from which request originates

Request body

extendedboolean

Whether extended login or normal login is required. If the parameter is set to Y your application will generate an authentication ticket valid for a period of 60 days, without expiring due to inactivity. If the parameter is left blank or set to N this means your application will support the normal expiry times for tickets: The ticket expires after 2 hours of inactivity. The ticket is valid for a maximum of 8 hours after it has been issued.

passwordstring required

Customer Password

usernamestring required

Customer Username

Response

Success

expiryDateTimestring required

The UTC time when the ticket expires.

extendedboolean

The value you have selected previous to executing the request. If the value is Y, this enables your application to generate a ticket valid for 60 days without expiring due to inactivity.

locationstring

This is the URL of the target service sent in the request. This is a combination of the endpoint and the ticket for future operations such as DELETE.

temporaryPasswordboolean

Indicates that the account has a temporary password set and hence the user must be prompted to change their password.

temporaryPasswordUrlstring

Url for user to change password. A TGT must be added to the URL

ticketstring required

The TGT ticket

All 4 operations