POST DealSheet/postvendoractivity

Post Activity from vendor systems.

Request Information

URI Parameters

None.

Body Parameters

PostVendorActivityRequest
NameDescriptionTypeAdditional information
entityList

List of one or more entities (GUID's) to assign the activity to.

Collection of globally unique identifier

None.

activityId

Activity Id

string

None.

vendorCustomerId

Vendor-specific Customer Id

string

None.

activityType

Activity Type

string

None.

activityDateUTC

Activity Date in UTC format

date

None.

notes

Notes

string

None.

performedByUserId

Performed By UserID. If the user is an AutoAlert user, this is the AutoAlert User ID, otherwise it is null.

integer

None.

performedByFirstName

Performed By First Name

string

None.

performedByLastName

Performed By Last Name

string

None.

contactedPhone

Contacted Phone Number. For use with outbound calls.

string

None.

subject

Subject. For use with inbound or outbound emails.

string

None.

fromEmailAddress

From Email Address. For use with inbound or outbound emails.

string

None.

toEmailAddress

To Email Address. For use with inbound or outbound emails.

string

None.

token

API access token

globally unique identifier

Required

Request Formats

application/json, text/json

Sample:
{
  "entityList": [
    "a5117141-1bb0-4127-adf9-135cb245a636",
    "80decbb2-f304-477b-bdd9-e1d4d718bda4"
  ],
  "activityId": "sample string 1",
  "vendorCustomerId": "sample string 2",
  "activityType": "sample string 3",
  "activityDateUTC": "2024-10-23T06:46:09.1266949-07:00",
  "notes": "sample string 5",
  "performedByUserId": 1,
  "performedByFirstName": "sample string 6",
  "performedByLastName": "sample string 7",
  "contactedPhone": "sample string 8",
  "subject": "sample string 9",
  "fromEmailAddress": "sample string 10",
  "toEmailAddress": "sample string 11",
  "token": "e1d3bd82-254f-4ff3-9fdf-8306fcb072d2"
}

application/xml, text/xml

Sample:
<PostVendorActivityRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models.DealSheet">
  <token xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API.Models">e1d3bd82-254f-4ff3-9fdf-8306fcb072d2</token>
  <activityDateUTC>2024-10-23T06:46:09.1266949-07:00</activityDateUTC>
  <activityId>sample string 1</activityId>
  <activityType>sample string 3</activityType>
  <contactedPhone>sample string 8</contactedPhone>
  <entityList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>a5117141-1bb0-4127-adf9-135cb245a636</d2p1:guid>
    <d2p1:guid>80decbb2-f304-477b-bdd9-e1d4d718bda4</d2p1:guid>
  </entityList>
  <fromEmailAddress>sample string 10</fromEmailAddress>
  <notes>sample string 5</notes>
  <performedByFirstName>sample string 6</performedByFirstName>
  <performedByLastName>sample string 7</performedByLastName>
  <performedByUserId>1</performedByUserId>
  <subject>sample string 9</subject>
  <toEmailAddress>sample string 11</toEmailAddress>
  <vendorCustomerId>sample string 2</vendorCustomerId>
</PostVendorActivityRequest>

Response Information

Resource Description

APIResult
NameDescriptionTypeAdditional information
code

API result code

integer

None.

error

API error message

string

None.

APIVersion

API Version

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "APIVersion": 1,
  "code": 200,
  "error": "sample string 2"
}

application/xml, text/xml

Sample:
<APIResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AutoAlert.API">
  <APIVersion>1</APIVersion>
  <error>sample string 2</error>
</APIResult>