Skip to main content

Update

PUT 

/keys/:key/licensees/:licensee

Update Licensee

Request

Path Parameters

    key stringrequired

    API Key

    The API Key to retrieve. Begins ak_.

    Example: ak_test
    licensee stringrequired

    Licensee Key

    Uniquely identifies a licensee.

    Example: sl_hk71kco54zGSGvF9eXXrvvnMOLLNh

Query Parameters

    user_token string

    Private User Token

    A secret key used for sensitive operations on your account and API Keys.

    Your user token can be retrieved and managed from your accounts page.

    Typically beings uk_...

    Example: uk_B59ScW1p1HHouf1VqclEPZUx

Body

required
    name string

    Licensee individual or organisation name

    address string

    Licensee's first, second and third line address as well as post town concatenated by commas

    postcode string

    Licensee's postcode

    whitelist string[]

    A list of allowed URLs. An empty list means that whitelisting is disabled

    daily object
    limit int32

    The maximum number of lookups this licensee can perform in a day. null indicates the limit is not active

Responses

Success

Schema
    result object

    Licensee object which can be defined by user

    name stringrequired

    Licensee individual or organisation name

    address stringrequired

    Licensee's first, second and third line address as well as post town concatenated by commas

    postcode stringrequired

    Licensee's postcode

    whitelist string[]required

    A list of allowed URLs. An empty list means that whitelisting is disabled

    daily objectrequired
    limit int32

    The maximum number of lookups this licensee can perform in a day. null indicates the limit is not active

    count int32required

    The number lookups performed by the licensee on the day represented b licesees.daily.updatedAt

    updatedAt stringrequired

    The timestamp when the limit was last used.

    id stringrequired

    An immutable ID provided for every licensee. Primarily used for paginated list requests.

    key stringrequired

    Uniquely identifies a licensee for a key.

    Required to perform paid lookups for a specific licensee. Typically begins sk_.

    createdAt stringrequired

    Timestamp for when the licensee was created

    code int32required

    Possible values: [2000]

    message stringrequired

    Possible values: [Success]

Loading...