Templates

Templates are user-defined message subjects and bodies for routine correspondence.

Supported Roles
Available Services
Templates Description
Expansions
API Explorer

Supported Roles

Role	Reads	Writes
IDX	No	No
Public	No	No
VOW	No	No
Portal	No	No
Private	Yes	No

More information about roles may be found here.

Available Services

All Templates

`/<API Version>/templates`

HTTP Method	Description	Conditional	Notes
GET	Returns all templates for the current user	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "20000426173054342350000000",
                "ResourceUri": "/v1/templates/20140609210008272136000000",
                "OwnerId": "20000809145531659995000000",
                "Name": "New Listings"
            }
        ],
        "Success": true
    }
}

Default Template

`/<API Version>/templates/default`

HTTP Method	Description	Conditional	Notes
GET	Returns the user's default template	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "20000426173054342350000000",
                "ResourceUri": "/v1/templates/20140609210008272136000000",
                "OwnerId": "20000809145531659995000000",
                "Name": "New Listings",
                "Subject": "New Listings!",
                "Body": "Here are some great new listings."
            }
        ],
        "Success": true
    }
}

Individual Template

`/<API Version>/templates/<Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified template with the provided Id	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Results": [
            {
                "Id": "20000426173054342350000000",
                "ResourceUri": "/v1/templates/20140609210008272136000000",
                "OwnerId": "20000809145531659995000000",
                "Name": "New Listings",
                "Body": "Here are some great new listings."
            }
        ],
        "Success": true
    }
}

Templates Description

Attribute	Data Type	Description
`ResourceUri`		The URI to the template resource.
`Id`		The unique Id for the template.
`OwnerId`		The account Id for the user the template belongs to.
`Name`		The name of the template.

Expansions

Expansion	Roles	Single Record Only?	Selection Support?	Description
`Subject`	All	No	No	The template's user defined subject.
`Body`	All	Yes	No	The template's message body.

API Explorer

Interact with this service using the API Explorer.