Top
Top
  1. Workamajig
  2. IT Info
  3. API Info

Articles in this section

API: Activities

Methods

Retrieve an activity

GET /activities?activityKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090
URL Parameters
activityKey: required <unique identifier for the activity>
Example Request
https://workamajig.com/api/beta1/activities?activityKey=YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090
Example Response
{
    "logid": "091e30c1-26b6-429c-8d62-2a64ebad9f52",
    "data": {
        "company": {
            "Fax": "asfasf",
            "CompanyTypeName": null,
            "BillableClient": 0,
            "ContactOwnerKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "LastModified": "2015-04-02T12:06:00",
            "ModifiedByName": "Greg O'Geiger",
            "OnHold": 0,
            "Vendor": 0,
            "CompanyKey": "YW9pbldVMHRXNHBjMmlpYzdKZE1vQT090",
            "ModifiedBy": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "DateUpdated": "2015-04-02T16:06:00",
            "NextActivitySubject": "Short",
            "CreatedByName": "Greg O'Geiger",
            "WebSite": "PepsiCo.com",
            "ParentCompany": 0,
            "DateAdded": "2015-02-03T15:07:00",
            "CreatedBy": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "ContactCount": 0,
            "IsFavorite": 1,
            "CompanyName": "Pepsi Colo",
            "Active": 1,
            "NextProjectNum": 1,
            "AccountManagerKey": "RWVWTEdNTkV0ZmlVV2JOYmdsOTFKUT090",
            "NextActivityDate": "2015-03-18T20:00:00",
            "AccountManagerName": "Greg O'Geiger",
            "Phone": null,
            "ContactOwnerName": "Greg O'Geiger",
            "NextActivityAssignedTo": "Greg O'Geiger",
            "OwnerCompanyKey": "SnRwMWdBSjRPQU9HZlcwa1VqaStaUT090",
            "NextActivityKey": "b2lmdi93VUJ1eWVpQXlRVVZJMmJadz090"
        }
    }
}
 

Create a new activity

POST /activities
Parameters
subject: required
activityDate: required
private: optional
reminderMinutes: optional
completed: optional
dateCompleted: optional
visibleToClients: optional
contactCompanyKey: optional
contactKey: optional
leadKey: optional
opportunityKey: optional
projectKey: optional
activityTypeKey: optional
assignedUserKey: optional
notes: optional

 

Example Request
https://workamajig.com/api/beta1/activities
[
 {
     "subject":"Make a call",
     "private":"1",
     "visibleToClient":"0",
     "activityDate":"2015-06-15T00:00:00Z",
     "notes":"Call the client to make an appointment."
 },
 {
     "subject":"Follow up",
     "private":"1",
     "visibleToClient":"0",
     "activityDate":"2015-06-18T00:00:00Z",
     "notes":"send an email regarding the phone call conversation."
 },
 
]
Example Response
{
  "success": [
    {
      "activityKey": "TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090",
      "data": {
        "private": "1",
        "visibleToClient": "0",
        "activityDate": "2015-06-15T00:00:00Z",
        "notes": "Call the client to make an appointment.",
        "subject": "Make a call"
      }
    },
    {
      "activityKey": "UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090",
      "data": {
        "private": "1",
        "visibleToClient": "0",
        "activityDate": "2015-06-18T00:00:00Z",
        "notes": "send an email regarding the phone call conversation.",
        "subject": "Follow up"
      }
    }
  ],
  "logid": "5eda3503-80db-438d-b164-f8266ecae29c"
}

 

 

Update an activity

PUT /activities/{id}
Parameters
activityKey: required <unique identifier for the activity>
subject: required
activityDate: required
private: optional
reminderMinutes: optional
completed: optional
dateCompleted: optional
visibleToClients: optional
contactCompanyKey: optional
contactKey: optional
leadKey: optional
opportunityKey: optional
projectKey: optional
activityTypeKey: optional
assignedUserKey: optional
notes: optional

 

Example Request
https://workamajig.com/api/beta1/activities
[
 {
     "activityKey":"TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090",
     "subject":"Make a call",
     "private":"1",
     "visibleToClient":"0",
     "activityDate":"2015-06-15T00:00:00Z",
     "notes":"Call the client to make an appointment."
 },
 {
     "subject":"Follow up",
     "private":"1",
     "visibleToClient":"0",
     "activityDate":"2015-06-18T00:00:00Z",
     "notes":"send an email regarding the phone call conversation."
 },
 
]
Example Response
{
  "success": [
    {
      "activityKey": "TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090",
      "data": {
        "private": "1",
        "visibleToClient": "0",
        "activityDate": "2015-06-15T00:00:00Z",
        "notes": "Call the client to make an appointment.",
        "subject": "Make a call"
      }
    },
    {
      "activityKey": "UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090",
      "data": {
        "private": "1",
        "visibleToClient": "0",
        "activityDate": "2015-06-18T00:00:00Z",
        "notes": "send an email regarding the phone call conversation.",
        "subject": "Follow up"
      }
    }
  ],
  "logid": "5eda3503-80db-438d-b164-f8266ecae29c"
}

 

Delete an activity

DELETE /activities/{id}
Parameters
activityKey: required <unique identifier for the activity>

 

Example Request
https://workamajig.com/api/beta1/activities
[
 { "activityKey":"TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090" },
 { "activityKey":"UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090" },
]
Example Response
{
  "success": [
    {
      "activityKey": "TzE4eU56VUJnTG03WWJtNVJmWFd0Zz090"     
    },
    {
      "activityKey": "UkNHY1o0U0hPUmFhb2c2WVJJMXpRUT090"
    }
  ],
  "logid": "5eda3503-80db-438d-b164-f8266ecae29c"
}

 

Related articles