prospects

Update prospect field values

Sets or updates the value of one or more fields on a prospect profile. To update a single field, provide <code>fieldId</code> and <code>attributeValue</code>. To update multiple fields in one request, provide an <code>attributes</code> array where each item contains a <code>fieldId</code> and the new value. Use the field IDs returned by the GET /fields endpoint.

post/v1/prospects/{prospectId}/attribute

Request

Base URL
https://developer.saleshandy.com (the document declares no server; this is the origin it was published from)
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/saleshandy/apis/develop-with-saleshandy/docs/v1/prospects/:prospectId/attribute/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

prospectIdstring required

Public prospect ID returned by prospect read/list APIs.

Request body

fieldIdstring

The ID of the field to update. Use this for updating a single field. Use the field IDs returned by the GET /fields endpoint. Required when "attributes" is not provided.

attributeValuestring

The new value to set for the field specified by "fieldId". Required when "fieldId" is provided.

Example request

{
  "fieldId": "1qPB1GBBwD",
  "attributeValue": "Smith",
  "attributes": [
    {
      "fieldId": "BVaD1mKgzo",
      "attributeValue": "John"
    },
    {
      "fieldId": "1qPB1GBBwD",
      "attributeValue": "Smith"
    }
  ]
}

Response

Prospect attribute updated successfully

unknown required

Example response

{
  "message": "Prospect attribute updated successfully",
  "payload": {
    "results": [
      {
        "fieldId": "Vj9kLp2Q",
        "success": true
      },
      {
        "fieldId": "r8PqN2xA",
        "success": true
      },
      {
        "fieldId": "INVALIDxx",
        "success": false
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 4 revisions of this API.