Circuit API › Sponsors

Returns all sponsors, ordered by ascending position.

Resource URL

https://api.toornament.com/circuit/v2/sponsors

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit 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

• circuit_ids

  array

  Only return circuits for the given list of ids.

  Example: 5617559294676615168,5629045554450325504

Request Body

This endpoint does not require a request body.

Response

[206] Sponsors retrieved.

Example

[
    {
        "id": "710724270669058052",
        "circuit_id": "5629045554450325504",
        "name": "My Weekly Circuit",
        "website": "http:\/\/www.toornament.com",
        "position": 5,
        "light_logo": {
            "id": "529400138800557512"
        }
    }
]

Structure (collection)

• id

  string

  The unique identifier of the sponsor.

  Example: "710724270669058052"

• circuit_id

  string

  The id of the circuit that contains this sponsor.

  Example: "5629045554450325504"

• name

  string

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Creates a new sponsor in a circuit.

Resource URL

https://api.toornament.com/circuit/v2/sponsors

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Query Parameters

This endpoint does not have any query parameters.

Request Body

Sponsor data

Example

{
    "circuit_id": "5629045554450325504",
    "name": "My Weekly Circuit",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557512"
    }
}

Structure (object)

• circuit_id

  string

  The id of the circuit that contains this sponsor.

  Example: "5629045554450325504"

• name

  string

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Response

[201] Sponsor created.

Example

{
    "id": "710724270669058052",
    "circuit_id": "5629045554450325504",
    "name": "My Weekly Circuit",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557512"
    }
}

Structure (object)

• id

  string

  The unique identifier of the sponsor.

  Example: "710724270669058052"

• circuit_id

  string

  The id of the circuit that contains this sponsor.

  Example: "5629045554450325504"

• name

  string

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Returns a sponsor identified with the given id.

Resource URL

https://api.toornament.com/circuit/v2/sponsors/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit 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": "710724270669058052",
    "circuit_id": "5629045554450325504",
    "name": "My Weekly Circuit",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557512"
    }
}

Structure (object)

• id

  string

  The unique identifier of the sponsor.

  Example: "710724270669058052"

• circuit_id

  string

  The id of the circuit that contains this sponsor.

  Example: "5629045554450325504"

• name

  string

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Updates one or several elements of a single sponsor.

Resource URL

https://api.toornament.com/circuit/v2/sponsors/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit scope (see Authorization)

Path parameters

• id

  string

  The id of the sponsor.

Query Parameters

This endpoint does not have any query parameters.

Request Body

Circuit data.

Example

{
    "name": "My Weekly Circuit",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557512"
    }
}

Structure (object)

• name

  string

  Optional

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Response

[200] Success.

Example

{
    "id": "710724270669058052",
    "circuit_id": "5629045554450325504",
    "name": "My Weekly Circuit",
    "website": "http:\/\/www.toornament.com",
    "position": 5,
    "light_logo": {
        "id": "529400138800557512"
    }
}

Structure (object)

• id

  string

  The unique identifier of the sponsor.

  Example: "710724270669058052"

• circuit_id

  string

  The id of the circuit that contains this sponsor.

  Example: "5629045554450325504"

• name

  string

  The name of the sponsor.

  Max. length: 30 characters

  Example: "My Weekly Circuit"

• 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.

  • id

    string

    The unique identifier of a file (with context "circuit_sponsor"), that can be used in other APIs.

    Example: "529400138800557512"

Deletes a single sponsor, identified by the given id.

Resource URL

https://api.toornament.com/circuit/v2/sponsors/{id}

HTTP headers

• X-Api-Key

  string

  API key of your application (see Authentication)

• Authorization

  string

  Access token with organizer:circuit 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.