Sync Leads¶

POST /rest/v1/leads.json

Permissions Read-Write Lead

Build a request and mock the response

Method: POST
Path: /rest/v1/leads.json
Tag: Leads
Operation ID: syncLeadUsingPOST

Syncs a list of leads to the target instance. Required Permissions: Read-Write Lead

Formats¶

Request: application/json
Response: application/json

Request¶

Request body¶

Name: syncLeadRequest
Required: Yes
Schema: model: SyncLeadRequest

syncLeadRequest

Generated example¶

{
  "action": "createOnly",
  "asyncProcessing": false,
  "input": [
    {
      "id": 123,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "lookupField": "string",
  "partitionName": "Example name"
}

Referenced models¶

SyncLeadRequest

Example request¶

POST {{base_url}}/rest/v1/leads.json
Content-Type: application/json
Accept: application/json

{
  "action": "createOnly",
  "asyncProcessing": false,
  "input": [
    {
      "id": 123,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "lookupField": "string",
  "partitionName": "Example name"
}

Responses¶

200 — OK¶

Schema: model: ResponseOfLead

Generated example¶

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "example-token",
  "requestId": "123",
  "result": [
    {
      "id": 123,
      "membership": {
        "acquiredBy": false,
        "isExhausted": false,
        "membershipDate": "string",
        "nurtureCadence": "string",
        "progressionStatus": "string",
        "reachedSuccess": false,
        "stream": "string"
      },
      "reason": {
        "code": "string",
        "message": "string"
      },
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models¶

ResponseOfLead

Source¶

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.