Prospects

Sync prospects from CRM

Syncs up to 100 CRM records (Salesforce or HubSpot) into Nooks prospects by externalId, creating them if they don't already exist. Per-record outcomes are returned in results and errors.

post/integrations/prospects/sync

Request

  • Base URL: https://partner-api.nooks.in/v1
  • URL: https://partner-api.nooks.in/v1/integrations/prospects/sync
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://oauth.nooks.in/oauth/authorize, token URL https://oauth.nooks.in/oauth/token, scopes: prospects:write)

Request body

Example request

{
  "data": {
    "records": [
      "003ABC123DEF456"
    ]
  }
}

Response

Request processed. Inspect results and errors for per-record outcomes.

Example response

{
  "results": [
    {
      "externalId": "003ABC123DEF456",
      "prospectId": "990e8400-e29b-41d4-a716-446655440020",
      "created": true
    }
  ],
  "errors": [
    {
      "externalId": "003ABC123DEF456",
      "code": "NOT_FOUND_IN_CRM",
      "message": "No record found in salesforce for externalId 003ABC123DEF456"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.