This user guide only applies if your account and project is on our new platform, i.e. if your project's URL begins with https://<your-account>.xp-dev.com rather than https://xp-dev.com. If your account is on our old platform, you should be using this user guide instead.
Each Forum Object has the following attributes:
Attribute | Description |
---|---|
id | Unique Forum ID |
name | Forum name |
project | Project ID that the Forum belongs to |
GET
request to
https://<your-account>.xp-dev.com/api/v1/forums/project/<project-id>
:
curl https://<your-account>.xp-dev.com/api/v1/forums/project/3
Responses will be a list of Forum Objects:
[
{
"name":"Support",
"id":2,
"project": {
"id": 3
}
},
...
]
POST
request to https://<your-account>.xp-dev.com/api/v1/forums
with the following
attributes:
Mandatory:
Example request:
curl -X POST -H 'Content-Type: application/json' -d '{"name":"Support","project":{"id":3}}' https://<your-account>.xp-dev.com/api/v1/forums
Responses will be in the form of a single Forum Object
GET
request to https://<your-account>.xp-dev.com/api/v1/forums/<forum-id>
. For
example:
curl https://<your-account>.xp-dev.com/api/v1/forums/6
Responses will be in the form of a single Forum Object
PUT
request to https://<your-account>.xp-dev.com/api/v1/forums/<forum-id>
with the
following attributes:
Mandatory:
Example request:
curl -X PUT -H 'Content-Type: application/json' -d '{"name":"Support"}' https://<your-account>.xp-dev.com/api/v1/forums/6
Responses will be in the form of a single Forum Object
DELETE
request to https://<your-account>.xp-dev.com/api/v1/forums/<forum-id>
:
curl -X DELETE https://<your-account>.xp-dev.com/api/v1/forums/6
Feel free to contact us if you need any assistance.