• Venue and event management in the cloud

How Can We Help?


Organisations: Create or Update

In this article


Create or Update

POST /v2/organisation/save

This API allows you to create or update an organisation within your Priava account

Parameter
OrganisationId    Long

The ID for an Organisation. Required only if updating an Organisation.

Name    String
 
An Organisation’s name.
Note: If an OrganisationId is not provided and that Organisation already exists with a given name, then that Organisation will be updated with the given details.
 
Inactive    Boolean

True to update an organisation to inactive. False to create an active organisation.

DebtorNumber    String

An Organisation’s debtor number.

Email    String

An Organisation’s primary email address.

EmailOther    String

Any other email for an Organisation.

BusinessPhone    String

An Organisation’s business/office phone number.

OtherPhone    String

Any other phone number for an Organisation.

Fax   String

An Organisation’s facsimile number.

PrimaryPhone    String
 
Specifies the primary phone number for an Organisation. The only accepted values are:
  • B for the Business number.
  • O for the Other number.
  • F for the Fax number
The primary phone by default is Business.
 
Website    String

The URL of an Organisation’s web site.

MarketSector    Object {Id, Name}

The market sector to be associated with an Organisation. The Organisation market sector must exist in your Priava Account. Passed in JSON format where:
Id = Id of the market sector.
Name = Name of the market sector

Type    Object {Id, Name}

The type of Organisation. The Organisation type must exist in your Priava Account. Passed in JSON format where:
Id = Id of the organisation type.
Name = Name of the organisation type.

ExternalRefNo    String

The external reference number for an Organisation.

TaxNo    String

The tax number for an Organisation.

Parent    String

The name of the parent Organisation (if any) that an Organisation belongs to. The parent Organisation must exist in your Priava Account.

CustomFields    Object

The custom fields for an organisation.

Address    Object Array
An array of addresses (up to 3) for this organisation. Passed in JSON format where:
  • AddressType = either POSTAL, BUSINESS or OTHER.
  • AddressLine1 = Line 1 of the address.
  • AddressLine2 = Line 2 of the address.
  • AddressLine3 = Line 3 of the address.
  • Suburb = The suburb for the address.
  • State = The State or County.
  • Postcode = The postal or zip code.
  • Country = The country of the address.
  • IsPrimary = To indicate whether this address is primary or not.
{
   "OrganisationId": "",
   "Name": "TestOrg09",
   "Parent": "Ford",
   "PrimaryPhone": "B",
   "Website": "www.test.com",
   "MarketSector": {
      "Name": "Healthcare",
      "Id": 30
   },
   "Type": {
      "Name": "Corporate",
      "Id": 41
   },
   "DebtorNumber": "123",
   "ExternalRefNo": "456",
   "CustomFields": {
      "OrgDD": [
         "Default Round-Robin"
      ],
      "OrgTF": "My custom text field is here."
   },
   "Inactive": false,
   "BusinessPhone": "5555666",
   "Fax": "965424",
   "EmailOther": "acmeorgot@hege.afds",
   "TaxNo": "123",
   "OtherPhone": "123987",
   "Email": "acmeorg@gmail.com",
   "Address": [{
         "AddressLine3": "BUSINESS Address 3",
         "AddressLine2": "BUSINESS Address 2",
         "AddressLine1": "BUSINESS Address 1",
         "Suburb": "Australian Capital",
         "State": "Queensland",
         "isPrimary": false,
         "Country": "Australia",
         "AddressType": "BUSINESS",
         "Postcode": "112098"
      },
      {
         "AddressLine3": "POSTAL Address 3",
         "AddressLine2": "POSTAL Address 2",
         "AddressLine1": "POSTAL Address 1",
         "Suburb": "Australian Capital",
         "State": "Queensland",
         "isPrimary": false,
         "Country": "Australia",
         "AddressType": "POSTAL",
         "Postcode": "112098"
      },
      {
         "AddressLine3": "OTHER Address 3",
         "AddressLine2": "OTHER Address 2",
         "AddressLine1": "OTHER Address 1",
         "Suburb": "Australian Capital",
         "State": "Queensland",
         "isPrimary": false,
         "Country": "Australia",
         "AddressType": "OTHER",
         "Postcode": "112098"
      }
   ]
}

Response:
{
   "success": true,
   "result": {
      "OrganisationId": 100158903
   }
}