Jump to

• Request
• Response
• Examples

Create Lead Notes

post

/appstore/publisher/v1/leads/{leadId}/notes

Create Note for a lead.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• leadId: integer(int64)
  Unique identifier of lead for which the note is to be created.

Body ()

Root Schema : notes

Type: object

Show Source

• createdBy(optional): string
• creationTime(optional): string
• note(optional): string

{
    "type":"object",
    "properties":{
        "note":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "creationTime":{
            "type":"string"
        }
    },
    "xml":{
        "name":"notes"
    }
}

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : acknowledgement

Type: object

Show Source

• contentURL(optional): string
• entityId(optional): string
• message(optional): string
• name(optional): string
• uri(optional): string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "entityId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "uri":{
            "type":"string"
        },
        "contentURL":{
            "type":"string"
        }
    },
    "xml":{
        "name":"acknowledgement"
    }
}

400 Response

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example creates a new notes for a lead by submitting a POST request on the REST resource using cURL.

cURL Example

curl -X POST -H "X-Oracle-UserId: partner-email" -H "Content-Type: application/json" -H "Authorization: Bearer Access-token -d JSON-data-as-shown-in-below-example' "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/leads/8006587/notes"

Request Header

X-Oracle-UserId: [e-mail]
Authorization: Bearer Access-token
Content-Type: application/json

Request Body

{
   "note":"Contacted the customer"
}

HTTP Status Code:

201 Created

JSON Response:

{
   "Message":"Lead Note created successfully.",
   "entityId":"8006587"
}

Back to Top