Jump to

• Request
• Response

Create the inbound mail token information.

post

/social/api/v1/inboundmail/token

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the request.

Root Schema : XV1InboundMailTokenCreateInfo

Type: object

V1 Inbound Mail Token Create Information.

Show Source

• command(optional): object XV1InboundMailCommand
• objectID(optional):
  An object's unique identifier from a long integer representation.

{
    "description":"V1 Inbound Mail Token Create Information.",
    "properties":{
        "command":{
            "$ref":"#/definitions/XV1InboundMailCommand"
        },
        "objectID":{
            "$ref":"#/definitions/XObjectID"
        }
    }
}

Nested Schema : XV1InboundMailCommand

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "CREATE_COMMENT", "CREATE_MESSAGE" ]

  V1 Social Module API Inbound Mail Command Types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Social Module API Inbound Mail Command Types.",
            "enum":[
                "CREATE_COMMENT",
                "CREATE_MESSAGE"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1InboundMailTokenInfo

Type: object

V1 Inbound Mail Token Information DTO.

Show Source

• command(optional): object XV1InboundMailCommand
• toAddress(optional): string
  To address, where the mail should be sent.
• token(optional): string
  Token to be embedded in mail subject and body.

{
    "description":"V1 Inbound Mail Token Information DTO.",
    "properties":{
        "command":{
            "$ref":"#/definitions/XV1InboundMailCommand"
        },
        "toAddress":{
            "description":"To address, where the mail should be sent.",
            "type":"string"
        },
        "token":{
            "description":"Token to be embedded in mail subject and body.",
            "type":"string"
        }
    }
}

Nested Schema : XV1InboundMailCommand

Type: object

Show Source

• field(optional): string
  Allowed Values: [ "CREATE_COMMENT", "CREATE_MESSAGE" ]

  V1 Social Module API Inbound Mail Command Types.

{
    "properties":{
        "field":{
            "type":"string",
            "description":"V1 Social Module API Inbound Mail Command Types.",
            "enum":[
                "CREATE_COMMENT",
                "CREATE_MESSAGE"
            ]
        }
    }
}

Back to Top