API / Stage

Entity Description:

Stage is defined as an area for individual contact information in the PoliteMail database. Stage includes other entities as Opt-In and Opt-Out information.

Properties

NameDescriptionTypeAdditional
Information
ID
Int32
Name
String

Entity Statement

if you are using versions earlier than 5.0, substitute "ssv3" for "api" for each Request listed below.

Creating a Stage

Request

POST /api/odata/Stages

Content-Type 

application/json

Request body

{
"ID":"0","Name":"New Stage"
}

Response body

{
"ID":1,"Name":"New Stage"
}
Deleting a Stage
 Request
 DELETE /api/odata/Stages(1)
 Response Headers
 HTTP/1.1 204 No Content
Getting a Stage
 Request
 GET /api/odata/Stages(1)
 Content-Type 
 application/json
 Response body
 {
"ID":1,"Name":"New Stage"
}
Updating a Stage
 Request
 PUT /api/odata/Stages(1)
 Content-Type 
 application/json
 Request body
 {
"ID":"0","Name":"New Stage"
}
 Response Headers
 HTTP/1.1 204 No Content
Getting all Stages
 Request
 GET /api/odata/Stages
 Content-Type
 application/json
 Response body
 "value":[{
"ID":0,"Name":"New Stage"
},{
"ID":1,"Name":"New Stage"
}]