Create CrmOpportunity

POST

api

crm

crmopportunities

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmopportunities \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CrmBoardColumnId": 123,
  "CoworkerId": 123,
  "Status": 123,
  "Position": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities"

payload = {
    "CrmBoardColumnId": 123,
    "CoworkerId": 123,
    "Status": 123,
    "Position": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CrmBoardColumnId: 123, CoworkerId: 123, Status: 123, Position: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmopportunities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CRM opportunity (CrmOpportunity) is a potential customer deal in a location’s CRM board, assigned to one CRM stage and tracked from enquiry through an in-progress, won, or lost outcome; moving it to a stage can run that stage’s configured automation.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CrmOpportunity-Create role.

Enums

eCrmOpportunitySource

Value	Name
1	Web
2	Phone
4	Webinar
5	Referral
6	PrintAdvert
7	PurchasedList
8	WordOfMouth
9	DirectEmail
10	EmailMarketing
11	Broker
12	PropertyAgent
13	Facebook
14	Linkedin
15	Instagram
16	Twitter
17	HubbleHq
18	LiquidSpace
19	GoogleSearch
20	SpacePool
21	InstantOffices
22	OfficeFreedom
23	FlexiOffices
24	Workthere
25	Kontor
26	Valve
98	OtherSocialNetwork
99	Other

eCrmOpportunityLossReason

Value	Name
1	Timing
2	Need
3	PoorQualification
4	Price
5	Feature
6	LostMomentum
7	Competition
8	ContractTerm
9	Duplicate
10	Waitlist
11	NotReturningCalls
12	LackOfFacilities
13	NoPetPolicy
14	NoRightFit
15	Location
16	Entrance
17	Errors
18	Archived
19	SearchOnHold
20	RelocationOnHold
99	Other

eCrmOpportunityStatus — Status values

Value	Name
1	InProgress
2	Won
3	Lost

Request Body

Required Fields

integer

required

ID of the CRM stage that contains this opportunity and determines its location access; changing it moves the opportunity and runs that stage’s arrival actions..

integer

required

ID of the customer this opportunity tracks; a customer is required by backend validation even though the relationship metadata is nullable..

integer

required

Lifecycle status: InProgress (1) is active, Won (2) records a successful outcome, and Lost (3) records an unsuccessful outcome; setting Won or Lost stamps the matching terminal timestamp if it is empty.. Defaults to InProgress.

integer

required

Requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update..

Optional Fields

string

Optional operator-facing label for this opportunity, useful when a customer has opportunities in multiple CRM boards..

integer

Optional ID of the team associated with this opportunity..

integer

Optional ID of the opportunity type used to categorize this CRM opportunity..

integer

Optional ID of the staff user responsible for following up this opportunity..

integer

Optional ID of the customer who referred this opportunity..

integer

Optional ID of the customer record representing the referring agent or broker..

string

Optional internal notes about this opportunity and its follow-up..

boolean

Whether this opportunity is marked complete; use Status to record whether it was won or lost..

string

Optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts..

number

Optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency..

boolean

Whether a follow-up reminder has already been sent for this opportunity; this internal state is not exposed to Admin Tool schemas..

integer

Optional acquisition source: Web, Phone, Webinar, Referral, PrintAdvert, PurchasedList, WordOfMouth, DirectEmail, EmailMarketing, Broker, PropertyAgent, Facebook, Linkedin, Instagram, Twitter, HubbleHq, LiquidSpace, GoogleSearch, SpacePool, InstantOffices, OfficeFreedom, FlexiOffices, Workthere, Kontor, Valve, OtherSocialNetwork, or Other.. See eCrmOpportunitySource? enum above.

integer

Optional reason for a lost opportunity: Timing, Need, PoorQualification, Price, Feature, LostMomentum, Competition, ContractTerm, Duplicate, Waitlist, NotReturningCalls, LackOfFacilities, NoPetPolicy, NoRightFit, Location, Entrance, Errors, Archived, SearchOnHold, RelocationOnHold, or Other; use only when Status is Lost.. See eCrmOpportunityLossReason? enum above.

string

Read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly..

string

Read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly..

string

Optional UTM source attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM medium attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM campaign attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM content attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM search-term attribution captured from the URL used to submit the originating contact or sign-up form..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/crm/crmopportunities" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CrmBoardColumnId": 0,
    "CoworkerId": null,
    "Status": 0,
    "Position": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunities',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CrmBoardColumnId: 0,
      CoworkerId: null,
      Status: 0,
      Position: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/crm/crmopportunities',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CrmBoardColumnId': 0,
        'CoworkerId': None,
        'Status': 0,
        'Position': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the crmopportunity was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CrmOpportunity was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Status: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Status"
    }
  ],
  "WasSuccessful": false
}

Create CrmOpportunity

curl --request POST \
  --url https://spaces.nexudus.com/api/crm/crmopportunities \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CrmBoardColumnId": 123,
  "CoworkerId": 123,
  "Status": 123,
  "Position": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities"

payload = {
    "CrmBoardColumnId": 123,
    "CoworkerId": 123,
    "Status": 123,
    "Position": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({CrmBoardColumnId: 123, CoworkerId: 123, Status: 123, Position: 123})
};

fetch('https://spaces.nexudus.com/api/crm/crmopportunities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400