Update Sponsor

Authorization

bearerAuth

AuthorizationBearer <token>

A key in the form pepvote_api_ followed by 32 hexadecimal characters.

In: header

Header Parameters

User-Agentstringrequired

Name and version of the calling integration. Required on every request.

Path Parameters

idOrCodestringrequired

Voting event ID or code.

idstringrequired

ID of the record.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Send at least 1 property

namestring

Sponsor name.

Length: 1 to 200 characters

infostring | null

Short blurb shown with the sponsor. Null clears it.

Length: up to 2000 characters
Nullable: send null to clear

contactEmailstring | null

Contact email. Null clears it.

Length: up to 320 characters
Nullable: send null to clear

pinnedSponsorNumberinteger | null

Position in the sponsor strip, starting at 1. Null unpins it.

Minimum value: 1
Nullable: send null to clear

Response Body

`application/json`

curl -X PATCH "https://example.com/voting-events/string/sponsors/string" \  -H "User-Agent: my-app/1.0" \  -H "Content-Type: application/json" \  -d '{}'

{
  "data": {
    "id": "string",
    "votingEventId": "string",
    "name": "string",
    "info": "string",
    "contactEmail": "string",
    "pinnedSponsorNumber": 0,
    "logoUrl": "string",
    "createdAt": 0
  }
}