Add Organisation
Add Organisation
OVERVIEW
Overview
Add a new organisation to Publisher
This API call is used to add a new organisation object to the system.
Since v4.6
HTTP Request
POST /api/2/organisations
HTTP Request Object
Organisation Object, either in JSON or XML format.
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
| Content-Type |
The format of the provided content.
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200 with Organisation summary Object
(Example below)
Error
Example HTTP Request & Response
POST http://example.com/context/api/2/organisations
JSON Request
{
"organisation": {
"name": "HighQ",
"status": "Active",
"autologin": true,
"domains": [
"highq.com"
],
"homepage": 451,
"guid": 23,
"url": "http://highq.com",
"addresses": [
{
"addressid": 8,
"isDefault": true
}
],
"img": "http://example.com/img.jpg",
"industry": 359,
"category": 145,
"keycontacts": [
476,
512,
987
],
"users": [
143,
476,
512,
987
]
}
}
JSON Response
{
"organisation": {
"id": 3,
"name": "HighQ",
"link": "http://example.com/context/api/2/organisations/3"
}
}
Thank you
Your review has been submitted.
Comments
0 Comments