Tournament API › Sponsors

Download OpenAPI 3.0

Endpoints

GET /tournament-sponsors

Returns all sponsors, ordered by ascending position.

Resource URL

https://api.toornament.com/organizer/v2/tournament-sponsors

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

  • Range
    string

    A range of requested items using the sponsors unit. The size of the range can not exceed 50. (see Pagination)

    Example: sponsors=0-49

Query Parameters

  • tournament_ids
    array

    Only return sponsors for the given list of tournaments.

    Example: 378426939508809728,534138941862841533

Request Body

This endpoint does not require a request body.

Response

[206] Sponsors retrieved.

Example
[
    {
        "id": "495923570669058051",
        "tournament_id": "378426939508809728",
        "name": "My Weekly Tournament",
        "website": "http:\/\/www.toornament.com",
        "position": 5,
        "light_logo": {
            "id": "529400138800557511"
        }
    }
]
Structure (collection)
  • id
    string

    The unique identifier of the sponsor.

    Example: "495923570669058051"

  • tournament_id
    string

    An identifier for a tournament; can be used in other APIs.

    Example: "378426939508809728"

  • name
    string

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    The sponsor logo reference object.

POST /tournament-sponsors

Creates a new sponsor in a tournament.

Resource URL

https://api.toornament.com/organizer/v2/tournament-sponsors

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Sponsor data

Example
{
    "tournament_id": "378426939508809728",
    "name": "My Weekly Tournament",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557511"
    }
}
Structure (object)
  • tournament_id
    string

    An identifier for a tournament; can be used in other APIs.

    Example: "378426939508809728"

  • name
    string

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    The sponsor logo reference object.

Response

[201] Sponsor created.

Example
{
    "id": "495923570669058051",
    "tournament_id": "378426939508809728",
    "name": "My Weekly Tournament",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557511"
    }
}
Structure (object)
  • id
    string

    The unique identifier of the sponsor.

    Example: "495923570669058051"

  • tournament_id
    string

    An identifier for a tournament; can be used in other APIs.

    Example: "378426939508809728"

  • name
    string

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    The sponsor logo reference object.

GET /tournament-sponsors/{id}

Returns a sponsor identified with the given id.

Resource URL

https://api.toornament.com/organizer/v2/tournament-sponsors/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the sponsor.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[200] Sponsor retrieved.

Example
{
    "id": "495923570669058051",
    "tournament_id": "378426939508809728",
    "name": "My Weekly Tournament",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557511"
    }
}
Structure (object)
  • id
    string

    The unique identifier of the sponsor.

    Example: "495923570669058051"

  • tournament_id
    string

    An identifier for a tournament; can be used in other APIs.

    Example: "378426939508809728"

  • name
    string

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    The sponsor logo reference object.

PATCH /tournament-sponsors/{id}

Updates one or several elements of a single sponsor.

Resource URL

https://api.toornament.com/organizer/v2/tournament-sponsors/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the sponsor.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Tournament data.

Example
{
    "name": "My Weekly Tournament",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557511"
    }
}
Structure (object)
  • name
    string

    Optional

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    Optional

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    Optional

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    Optional

    The sponsor logo reference object.

Response

[200] Success.

Example
{
    "id": "495923570669058051",
    "tournament_id": "378426939508809728",
    "name": "My Weekly Tournament",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557511"
    }
}
Structure (object)
  • id
    string

    The unique identifier of the sponsor.

    Example: "495923570669058051"

  • tournament_id
    string

    An identifier for a tournament; can be used in other APIs.

    Example: "378426939508809728"

  • name
    string

    The name of the sponsor.

    Max. length: 30 characters

    Example: "My Weekly Tournament"

  • website
    string|null

    The sponsor's website URL.

    Example: "http://www.toornament.com"

  • position
    integer

    The position of the sponsor (used for display purposes).

    Example: 5

  • light_logo
    object

    The sponsor logo reference object.

DELETE /tournament-sponsors/{id}

Deletes a single sponsor, identified by the given id.

Resource URL

https://api.toornament.com/organizer/v2/tournament-sponsors/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:admin scope (see Authorization)

Path parameters

  • id
    string

    The id of the sponsor.

Query Parameters

This endpoint does not have any query parameters.

Request Body

This endpoint does not require a request body.

Response

[204] Success.