Referencia de la API medal | AppointmentTrader

Buscar en todos los endpoints

/v1/medal/

Manages All Medal and User Permission Related Functions

GET

/v1/medal/get_available_medal_categories

Searches all available medal categories on the platform

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`searchFilter`	`string`	`No`	`""`	filter criteria
`restrictToSponsorableByUserAlias`	`string`	`No`	`""`	if set, only medals that can be sponsored by this userAlias will be returned
`filterBy`	`string`	`No`	`"Slug"`	comma seperated list of fields that should be included
`pageSize`	`int`	`No`	`50`	Defines how many results will be return per request
`pageNumber`	`int`	`No`	`0`	Defines which page should be returned

Ejemplo de solicitud (cURL)

curl --get \
  'https://es.appointmenttrader.com/v1/medal/get_available_medal_categories' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'searchFilter={{searchFilter}}' \
  --data-urlencode 'restrictToSponsorableByUserAlias={{restrictToSponsorableByUserAlias}}' \
  --data-urlencode 'filterBy={{filterBy}}' \
  --data-urlencode 'pageSize={{pageSize}}' \
  --data-urlencode 'pageNumber={{pageNumber}}'

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio	Descripción
`$`	`medal_get_available_medal_categories_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.ATResponseObjectType`	`= "NestedKeyValueList"`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.Name`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.MetaInformation[]`	`string`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategorySlug`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryName`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription`		`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[0]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryDescription.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL`		`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[0]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryIconURL.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor`		`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[0]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryColor.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor`		`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[0]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].medalCategoryTextColor.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].IsNegativeMedal.oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueList[].DisplayOnDirectListings.oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.ResponseBody.KeyValueFieldList[]`	`string`	`No`
`$.oneOf[1]`	`object`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/medal/get_available_medal_categories",
    "RequestUserAlias": "example-user",
    "Payload": {
        "ATResponseObjectType": "NestedKeyValueList",
        "ResponseBody": {
            "Name": "synthetic-example",
            "MetaInformation": [],
            "KeyValueList": [],
            "KeyValueFieldList": []
        }
    }
}

Documentación del endpoint legible por máquinas

GET

/v1/medal/get_profile_sponsorships

Returns the viewed user's current medal sponsor and directly sponsored users, with public identities only. Public-by-design: approved sponsorships are visible only when the caller can view both related profiles.

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`userAlias`	`string`	`si`	`—`	Profile owner to inspect.
`medalCategorySlug`	`string`	`si`	`—`	Medal category, not a tier slug.
`afterUserID`	`int`	`No`	`0`	Cursor from nextAfterUserID; zero starts the list.
`pageSize`	`int`	`No`	`20`	Number of visible sponsored users, from 1 to 50.

Ejemplo de solicitud (cURL)

curl --get \
  'https://es.appointmenttrader.com/v1/medal/get_profile_sponsorships' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'afterUserID={{afterUserID}}' \
  --data-urlencode 'pageSize={{pageSize}}'

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio
`$`	`medal_get_profile_sponsorships_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.profileAlias`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.medalCategorySlug`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor`		`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].userID`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].alias`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].avatar`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].imageURL`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].profileURL`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[0].displayHTML`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsor.anyOf[1]`	`null`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers`	`array`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].userID`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].alias`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].avatar`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].imageURL`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].profileURL`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.sponsoredUsers[].displayHTML`	`string`	`si`
`$.oneOf[0].allOf[1].Payload.hasMore`	`boolean`	`si`
`$.oneOf[0].allOf[1].Payload.nextAfterUserID`		`si`
`$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].Payload.nextAfterUserID.anyOf[1]`	`null`	`si`
`$.oneOf[1]`	`object`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/medal/get_profile_sponsorships",
    "RequestUserAlias": "example-user",
    "Payload": {
        "profileAlias": "synthetic-example",
        "medalCategorySlug": "synthetic-example",
        "sponsor": {
            "userID": 0,
            "alias": "synthetic-example",
            "avatar": "synthetic-example",
            "imageURL": "synthetic-example",
            "profileURL": "synthetic-example",
            "displayHTML": "synthetic-example"
        },
        "sponsoredUsers": [],
        "hasMore": false,
        "nextAfterUserID": 0
    }
}

Documentación del endpoint legible por máquinas

POST

/v1/medal/set_request_medal_sponsorship

Request Medal Sponsorship will be asked to sponsor the medal defined below for you.

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`sponsorUserAlias`	`string`	`si`	`—`	Alias Identifying the User to be sponsored
`medalCategorySlug`	`string`	`si`	`—`	Slug Identifying the Medal Category You Want to be Sponsored for
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Ejemplo de solicitud (cURL)

curl --request POST \
  'https://es.appointmenttrader.com/v1/medal/set_request_medal_sponsorship' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sponsorUserAlias={{sponsorUserAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio	Descripción
`$`	`medal_set_request_medal_sponsorship_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`= true`	`si`
`$.oneOf[0].allOf[1].ResponseMessage`	`object`	`No`
`$.oneOf[0].allOf[1].ResponseMessage.HumanReadable`	`string`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables`	`object`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURL`	`string`	`si`
`$.oneOf[1]`	`object`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": {
        "HumanReadable": "Synthetic sponsorship request.",
        "ReturnVariables": {
            "RequestChatID": 1001,
            "RequestChatURL": "/modules/community/index.php?Tags[]=synthetic-chat"
        }
    },
    "RequestPath": "/v1/medal/set_request_medal_sponsorship",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Documentación del endpoint legible por máquinas

POST

/v1/medal/set_sponsor_user

Sponsor A Medal for will be recommended for the medal you define below.

Parámetros

Nombre	Tipo	Obligatorio	Predeterminado	Descripción
`userAlias`	`string`	`si`	`—`	Alias Identifying the User to be sponsored
`medalCategorySlug`	`string`	`si`	`—`	Slug Identifying the Medal Category You Want to Sponsor
`isWritingRequest`	`bool`	`No`	`false`	all set_[...] functions have this parameter - if false (which is default) the method will execute without writing any data. Set this parameter to true once you are sure that you tested your logic and want to execute a writing request

Ejemplo de solicitud (cURL)

curl --request POST \
  'https://es.appointmenttrader.com/v1/medal/set_sponsor_user' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'userAlias={{userAlias}}' \
  --data-urlencode 'medalCategorySlug={{medalCategorySlug}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Respuesta

JSON

See the shared response schema and synthetic example.

Campos de respuesta

Campo	Tipo	Obligatorio	Descripción
`$`	`medal_set_sponsor_user_Response`	`si`
`$.oneOf[0]`		`si`
`$.oneOf[0].allOf[0]`	`object`	`si`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`si`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`si`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`si`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`si`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`si`
`$.oneOf[0].allOf[1].Payload`	`= true`	`si`
`$.oneOf[0].allOf[1].ResponseMessage`	`object`	`No`
`$.oneOf[0].allOf[1].ResponseMessage.HumanReadable`	`string`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables`	`object`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID`	`DatabaseInteger`	`si`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[0]`	`integer`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatID.oneOf[1]`	`string`	`si`
`$.oneOf[0].allOf[1].ResponseMessage.ReturnVariables.RequestChatURL`	`string`	`si`
`$.oneOf[1]`	`object`	`si`
`$.oneOf[1].RequestUserAlias`	`string`	`si`
`$.oneOf[1].RequestPath`	`string \| null`	`si`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`si`
`$.oneOf[1].ResponseCode`	`integer`	`si`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`si`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`si`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`si`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Ejemplo de respuesta

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": {
        "HumanReadable": "Synthetic sponsorship request.",
        "ReturnVariables": {
            "RequestChatID": 1001,
            "RequestChatURL": "/modules/community/index.php?Tags[]=synthetic-chat"
        }
    },
    "RequestPath": "/v1/medal/set_sponsor_user",
    "RequestUserAlias": "example-user",
    "Payload": true
}

Documentación del endpoint legible por máquinas