{"info":{"title":"mail object","version":"1.0","contact":{"name":"Beamable Support","url":"https://api.beamable.com","email":"support@beamable.com"}},"servers":[{"url":"https://api.beamable.com"}],"paths":{"/object/mail/{objectId}/detail":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"mid","in":"query","schema":{"type":"integer","format":"int64"},"required":true},{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/mail/{objectId}/categories":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMailCategoriesResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/mail/{objectId}/search":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSearchResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSearchRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/mail/{objectId}/bulk":{"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSuccessResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSendMailRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSuccessResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkUpdateMailObjectRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/mail/{objectId}/accept/many":{"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSuccessResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptMultipleAttachments"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]},"/object/mail/{objectId}/":{"get":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailQueryResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"security":[{}]},"post":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMailResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendMailObjectRequest"}}}},"security":[{"user":["developer"]},{"server":[]}]},"put":{"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailSuccessResponse"}}}},"400":{"description":"Bad Request"}},"parameters":[{"name":"objectId","in":"path","schema":{"type":"string"},"description":"Gamertag of the player.Underlying objectId type is integer in format int64.","required":true,"x-beamable-object-id":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMailRequest"}}}},"security":[{}]},"parameters":[{"name":"X-BEAM-SCOPE","in":"header","schema":{"type":"string"},"description":"Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.","required":true},{"name":"X-BEAM-GAMERTAG","in":"header","schema":{"type":"string"},"description":"Override the Gamer Tag of the player. This is generally inferred by the auth token.","required":false}]}},"components":{"schemas":{"UpdateMailRequest":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"string"},"expires":{"type":"string"},"subject":{"type":"string"},"state":{"type":"string"},"mailId":{"type":"integer","format":"int64"},"category":{"type":"string"},"acceptAttachments":{"type":"boolean"}},"required":["mailId"]},"ItemCreateRequest":{"type":"object","additionalProperties":false,"properties":{"contentId":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ItemProperty"}}},"required":["contentId","properties"]},"MailSearchClause":{"type":"object","additionalProperties":false,"properties":{"forSender":{"type":"integer","format":"int64"},"name":{"type":"string"},"onlyCount":{"type":"boolean"},"categories":{"type":"array","items":{"type":"string"}},"start":{"type":"integer","format":"int64"},"limit":{"type":"integer","format":"int32"},"states":{"type":"array","items":{"type":"string"}}},"required":["name","onlyCount"]},"WebhookComet":{"type":"object","additionalProperties":false,"properties":{"method":{"type":"string"},"description":{"type":"string"},"variables":{"$ref":"#/components/schemas/RouteVariables"},"symbol":{"type":"string"},"route":{"$ref":"#/components/schemas/ServiceRoute"},"parameters":{"$ref":"#/components/schemas/RouteParameters"}},"required":["symbol","method","route","variables","parameters"]},"WebhookServiceType":{"type":"string","enum":["UserMicroservice","ObjectService","BasicService"]},"WebhookInvocationType":{"type":"string","enum":["NonBlocking","Blocking"]},"RouteVariable":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"typeName":{"type":"string"}},"required":["name","typeName"]},"WebhookInvocationStrategy":{"type":"object","additionalProperties":false,"properties":{"invocationType":{"$ref":"#/components/schemas/WebhookInvocationType"},"retryType":{"$ref":"#/components/schemas/WebhookRetryType"}},"required":["invocationType","retryType"]},"AttachmentRequest":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32"},"symbol":{"type":"string"},"specialization":{"type":"string"},"target":{"type":"integer","format":"int64"},"action":{"type":"string"}},"required":["symbol","action"]},"RouteParameter":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"body":{"type":"string"},"typeName":{"type":"string"},"variableRef":{"$ref":"#/components/schemas/VariableReference"}},"required":["name","body","typeName"]},"MailSearchRequest":{"properties":{"clauses":{"type":"array","items":{"$ref":"#/components/schemas/MailSearchClause"}}},"additionalProperties":false,"title":"Mail Search Request","type":"object","required":["clauses"]},"RouteVariables":{"type":"object","additionalProperties":false,"properties":{"variables":{"type":"array","items":{"$ref":"#/components/schemas/RouteVariable"}}},"required":["variables"]},"PlayerReward":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string"},"addItemRequests":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"changeCurrencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyChangeReward"}},"callWebhooks":{"type":"array","items":{"$ref":"#/components/schemas/WebhookReward"}},"addItems":{"type":"array","items":{"$ref":"#/components/schemas/NewItemReward"}},"applyVipBonus":{"type":"boolean"},"addCurrencyMap":{"type":"object","additionalProperties":{"type":"string"}}},"required":["addCurrencyMap","addItemRequests"]},"EntitlementGenerator":{"type":"object","additionalProperties":false,"properties":{"quantity":{"type":"integer","format":"int32"},"claimWindow":{"$ref":"#/components/schemas/EntitlementClaimWindow"},"params":{"type":"object","additionalProperties":{"type":"string"}},"symbol":{"type":"string"},"specialization":{"type":"string"},"action":{"type":"string"}},"required":["symbol","action"]},"MailSearchResponse":{"properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/MailSearchResponseClause"}}},"additionalProperties":false,"title":"Mail Search Response","type":"object","required":["results"]},"VariableReference":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"}},"required":["name"]},"RouteParameters":{"type":"object","additionalProperties":false,"properties":{"parameters":{"type":"array","items":{"$ref":"#/components/schemas/RouteParameter"}},"payload":{"type":"string"},"objectId":{"type":"string"}},"required":["parameters"]},"SendMailObjectRequest":{"properties":{"body":{"type":"string"},"expires":{"type":"string"},"playerRewards":{"$ref":"#/components/schemas/PlayerReward"},"subject":{"type":"string"},"rewards":{"$ref":"#/components/schemas/MailRewards"},"id":{"type":"integer","format":"int64"},"senderGamerTag":{"type":"integer","format":"int64"},"category":{"type":"string"},"bodyRef":{"type":"integer","format":"int64"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentRequest"}}},"additionalProperties":false,"title":"Send Mail Object Request","type":"object","required":["senderGamerTag","category"]},"SendMailResponse":{"properties":{"mailId":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Send Mail Response","type":"object"},"MailResponse":{"properties":{"result":{"$ref":"#/components/schemas/Message"}},"additionalProperties":false,"title":"Mail Response","type":"object"},"MyMailUpdate":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"},"update":{"$ref":"#/components/schemas/UpdateMailRequest"}},"required":["id","update"]},"SendMailRequest":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"string"},"expires":{"type":"string"},"playerRewards":{"$ref":"#/components/schemas/PlayerReward"},"receiverGamerTag":{"type":"integer","format":"int64"},"subject":{"type":"string"},"rewards":{"$ref":"#/components/schemas/MailRewards"},"id":{"type":"integer","format":"int64"},"senderGamerTag":{"type":"integer","format":"int64"},"category":{"type":"string"},"bodyRef":{"type":"integer","format":"int64"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AttachmentRequest"}}},"required":["senderGamerTag","receiverGamerTag","category"]},"CurrencyChange":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"},"originalAmount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"Attachment":{"type":"object","additionalProperties":false,"properties":{"id":{"type":"integer","format":"int64"},"wrapped":{"$ref":"#/components/schemas/EntitlementGenerator"},"state":{"type":"string"},"target":{"type":"integer","format":"int64"}},"required":["id","wrapped","state"]},"ServiceRoute":{"type":"object","additionalProperties":false,"properties":{"service":{"type":"string"},"endpoint":{"type":"string"},"serviceTypeStr":{"$ref":"#/components/schemas/WebhookServiceType"}},"required":["service","endpoint","serviceTypeStr"]},"AcceptMultipleAttachments":{"properties":{"mailIds":{"type":"array","items":{"type":"integer","format":"int64"}}},"additionalProperties":false,"title":"Accept Multiple Attachments","type":"object","required":["mailIds"]},"GetMailDetailsRequest":{"properties":{"mid":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Get Mail Details Request","type":"object","required":["mid"]},"EntitlementClaimWindow":{"type":"object","additionalProperties":false,"properties":{"open":{"type":"integer","format":"int64"},"close":{"type":"integer","format":"int64"}},"required":["open","close"]},"CurrencyChangeReward":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"amount":{"type":"integer","format":"int64"}},"required":["symbol","amount"]},"Message":{"type":"object","additionalProperties":false,"properties":{"body":{"type":"string"},"expires":{"type":"integer","format":"int64","x-beamable-date-format":"unix","description":"Milliseconds since midnight, January 1, 1970 UTC"},"playerRewards":{"$ref":"#/components/schemas/PlayerReward"},"receiverGamerTag":{"type":"integer","format":"int64"},"subject":{"type":"string"},"state":{"type":"string"},"rewards":{"$ref":"#/components/schemas/MailRewards"},"id":{"type":"integer","format":"int64"},"senderGamerTag":{"type":"integer","format":"int64"},"sent":{"type":"integer","format":"int64","x-beamable-date-format":"unix","description":"Milliseconds since midnight, January 1, 1970 UTC"},"category":{"type":"string"},"bodyRef":{"type":"integer","format":"int64"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"}},"claimedTimeMs":{"type":"integer","format":"int64"}},"required":["id","sent","receiverGamerTag","senderGamerTag","category","state","attachments"]},"MailQueryResponse":{"properties":{"unreadCount":{"type":"integer","format":"int64"}},"additionalProperties":false,"title":"Mail Query Response","type":"object","required":["unreadCount"]},"ItemProperty":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"value":{"type":"string"}},"required":["name","value"]},"WebhookReward":{"type":"object","additionalProperties":false,"properties":{"webhookSymbol":{"type":"string"},"strategy":{"$ref":"#/components/schemas/WebhookInvocationStrategy"},"webHookComet":{"$ref":"#/components/schemas/WebhookComet"}},"required":["strategy"]},"MailSuccessResponse":{"properties":{"result":{"type":"boolean"}},"additionalProperties":false,"title":"Mail Success Response","type":"object","required":["result"]},"NewItemReward":{"type":"object","additionalProperties":false,"properties":{"symbol":{"type":"string"},"properties":{"type":"object","additionalProperties":{"type":"string"}}},"required":["symbol"]},"WebhookRetryType":{"type":"string","enum":["None","Once","ExponentialBackoff"]},"BulkSendMailRequest":{"properties":{"sendMailRequests":{"type":"array","items":{"$ref":"#/components/schemas/SendMailRequest"}}},"additionalProperties":false,"title":"Bulk Send Mail Request","type":"object","required":["sendMailRequests"]},"BulkUpdateMailObjectRequest":{"properties":{"updateMailRequests":{"type":"array","items":{"$ref":"#/components/schemas/MyMailUpdate"}}},"additionalProperties":false,"title":"Bulk Update Mail Object Request","type":"object","required":["updateMailRequests"]},"MailRewards":{"type":"object","additionalProperties":false,"properties":{"currencies":{"type":"array","items":{"$ref":"#/components/schemas/CurrencyChange"}},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}},"applyVipBonus":{"type":"boolean"}},"required":["currencies","items"]},"ListMailCategoriesResponse":{"properties":{"result":{"type":"array","items":{"type":"string"}}},"additionalProperties":false,"title":"List Mail Categories Response","type":"object","required":["result"]},"MailSearchResponseClause":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string"},"count":{"type":"integer","format":"int64"},"content":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"required":["name","count"]}},"securitySchemes":{"server":{"type":"apiKey","name":"X-DE-SIGNATURE","in":"header","description":"Signed Request authentication using project secret key."},"user":{"type":"http","description":"Bearer authentication with a player access token in the Authorization header.","scheme":"bearer","bearerFormat":"Bearer <Access Token>"}}},"security":[],"externalDocs":{"description":"Beamable Documentation","url":"https://docs.beamable.com"},"openapi":"3.0.2"}