/activities

from merge import Merge
from merge.resources.ats import ActivityRequest
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.ats.activities.create(
    model=ActivityRequest(),
    remote_user_id="remote_user_id",
)

{
  "model": {
    "id": "ecbe05ac-62a3-46c5-ab31-4b478b37d1b4",
    "remote_id": "198123",
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
    "user": "9d892439-5fab-4dbb-8bd8-34f7f96c7912",
    "remote_created_at": "2021-10-15T00:00:00Z",
    "activity_type": "NOTE",
    "subject": "Gil Feig's interview",
    "body": "Candidate loves integrations!",
    "visibility": "PRIVATE",
    "candidate": "550e8400-e29b-41d4-a716-446655440000",
    "remote_was_deleted": true,
    "field_mappings": {
      "organization_defined_targets": {
        "custom_key": "custom_value"
      },
      "linked_account_defined_targets": {
        "custom_key": "custom_value"
      }
    },
    "remote_data": [
      {
        "path": "/actions"
      }
    ]
  },
  "warnings": [
    {
      "title": "Unrecognized Field",
      "detail": "An unrecognized field, age, was passed in with request data.",
      "problem_type": "UNRECOGNIZED_FIELD",
      "source": {
        "pointer": "/age"
      },
      "block_merge_link": true
    }
  ],
  "errors": [
    {
      "title": "Missing Required Field",
      "detail": "custom_fields is a required field on model.",
      "problem_type": "MISSING_REQUIRED_FIELD",
      "source": {
        "pointer": "/model/custom_fields"
      },
      "block_merge_link": true
    }
  ],
  "logs": [
    {
      "log_id": "99433219-8017-4acd-bb3c-ceb23d663832",
      "dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832",
      "log_summary": {
        "url": "www.exampleintegration.com/api/v1/exampleapi",
        "method": "POST",
        "status_code": 200
      }
    }
  ]
}

Creates an Activity object with the given values.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

is_debug_modebooleanOptional

Whether to include debug fields (such as log file links) in the response.

run_asyncbooleanOptional

Whether or not third-party updates should be run asynchronously.

Request

This endpoint expects an object.

modelobjectRequired

Description

The Activity object is used to represent an activity for a candidate performed by a user.

Usage Example

Fetch from the LIST Activities endpoint and filter by ID to show all activities.

remote_user_idstringRequired

Response

modelobject

Description

The Activity object is used to represent an activity for a candidate performed by a user.

Usage Example

Fetch from the LIST Activities endpoint and filter by ID to show all activities.

warningslist of objects

errorslist of objects

logslist of objects or null

Supported POST model parameters

activity_typeenum or nullRequired

The activity’s type.

NOTE - NOTE
EMAIL - EMAIL
OTHER - OTHER

Allowed values:

candidatestring or nullRequiredformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The user that performed the action.

remote_created_atdatetime or nullOptional

When the third party's activity was created.

subjectstring or nullOptional

The activity's subject.

bodystring or nullOptional

The activity's body.

remote_datalist of objects or nullOptionalRead-only

Supported POST model parameters

activity_typeenum or nullRequired

The activity’s type.

NOTE - NOTE
EMAIL - EMAIL
OTHER - OTHER

Allowed values:

candidatestring or nullRequiredformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The user that performed the action.

remote_created_atdatetime or nullOptional

When the third party's activity was created.

subjectstring or nullOptional

The activity's subject.

bodystring or nullOptional

The activity's body.

visibilityenum or nullOptional

The activity’s visibility.

ADMIN_ONLY - ADMIN_ONLY
PUBLIC - PUBLIC
PRIVATE - PRIVATE

Allowed values:

Supported POST model parameters

activity_typeenum or nullRequired

The activity’s type.

NOTE - NOTE
EMAIL - EMAIL
OTHER - OTHER

Allowed values:

candidatestring or nullRequiredformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The user that performed the action.

remote_created_atdatetime or nullOptional

When the third party's activity was created.

subjectstring or nullOptional

The activity's subject.

bodystring or nullOptional

The activity's body.

remote_datalist of objects or nullOptionalRead-only

Supported POST model parameters

activity_typeenum or nullRequired

The activity’s type.

NOTE - NOTE
EMAIL - EMAIL
OTHER - OTHER

Allowed values:

candidatestring or nullRequiredformat: "uuid"

remote_idstring or nullOptional

The third-party API ID of the matching object.

userstring or nullOptionalformat: "uuid"

The user that performed the action.

remote_created_atdatetime or nullOptional

When the third party's activity was created.

subjectstring or nullOptional

The activity's subject.

bodystring or nullOptional

The activity's body.

visibilityenum or nullOptional

The activity’s visibility.

ADMIN_ONLY - ADMIN_ONLY
PUBLIC - PUBLIC
PRIVATE - PRIVATE

Allowed values:

Authentication

Headers

Query parameters

Request

Description

Usage Example

Response

Description

Usage Example

Field support by integration

Field support by integration