Add Activity

POST

POST

https://api.atzcrm.com/v1/activity

Create a new activity such as a meeting, task, email, or interview.

Request Example

{
    "title": "Client Demo Call",
    "activity_type_id": 3,
    "related_to_entity": 1,
    "related_to": "candidate_2f0ea5cd69a6cd6c7163",
    "collaborators": "1",
    "start_datetime": "2026-04-25T10:00:00Z",
    "end_datetime": "2026-04-25T11:00:00Z",
    "candidates_as_attendees": "candidate_2f0ea5cd69a6cd6c7163",
    "contacts_as_attendees": "contact_d86c343cf49040381fc7",
    "users_as_attendees": "1",
    "meeting_link": "https://meet.google.com/xyz-abcd-efg",
    "importance": "normal",
    "location": "Zoom",
    "description": "Discuss product demo and onboarding",
    "do_not_send_calendar_invite": true,
    "mark_as_done": false,
    "attachment": "https://example.com/files/sample-agenda.pdf"
}

Inbuilt Activity Types

ATZ CRM provides the following built-in activity types you can use directly via activity_type_id:

ID	Label
2	Meeting
3	Task
4	Email
5	Interview

Custom activity types created in your account are also valid.

Request

Body

• titlestring

  Max 100 characters (required)

• activity_type_idinteger

  Positive integer. Use 2 (Meeting), 3 (Task), 4 (Email), 5 (Interview), or a custom type ID (required). To fetch all available types for your account, use the Get Activity Types endpoint.

• start_datetimestring

  ISO 8601 datetime (required). Example: 2024-06-15T10:00:00Z

• end_datetimestring

  ISO 8601 datetime, must be after start_datetime (required). Example: 2024-06-15T11:00:00Z

• related_to_entityinteger

  Entity type: 1 (Candidate), 2 (Job), 3 (Organization), 4 (Contact), 5 (Deal), 10 (Other)

• related_tostring

  Slug of the related record (max 50 characters). Must exist in the account.

• collaboratorsstring

  Comma-separated user IDs. Example: "1,2,3"

• candidates_as_attendeesstring

  Comma-separated candidate slugs. Example: "candidate_2f0ea5cd69a6cd6c7163,candidate_9b3fa1de02c741ab8821"

• contacts_as_attendeesstring

  Comma-separated contact slugs. Example: "contact_d86c343cf49040381fc7,contact_a12b456cd78ef9012345"

• users_as_attendeesstring

  Comma-separated user IDs. Example: "1,2"

• meeting_linkstring

  Valid URL, max 100 characters. Example: "https://meet.google.com/abc-xyz"

• importancestring

  One of: low, normal, high, critical. Defaults to high.

• locationstring

  Max 50 characters.

• descriptionstring

  Free-text description of the activity.

• do_not_send_calendar_inviteboolean

  Set to true to suppress calendar invite. Defaults to false.

• mark_as_doneboolean

  Mark the activity as completed. Defaults to false.

• attachmentfile or string

  Upload a file via multipart/form-data, or provide a URL string (max 350 characters).

Headers

• Authorization: Bearer your_access_token

Response

200

Body

• idnumber

  Example: 42

• titlestring

  Example: Team Sync

• activity_typeobject

  Example:
  "id": 2,
  "label": "Meeting"

• related_tostring

  Slug of the related record. Example: candidate_abc123

• related_recordobject

  Example:
  "slug": "candidate_abc123"

• related_to_typestring

  Example: candidate

• collaboratorsarray

  Example:
  "id": 1,
  "slug": "user_abc",
  "full_name": "John Doe",
  "email": "john@example.com"

• start_datestring

  Example: 2024-06-15

• start_timestring

  Example: 10:00

• end_timestring

  Example: 11:00

• attendeesobject

  Contains three arrays: candidates, contacts, users. Each entry includes slug and full_name (users also include email).

• meeting_linkstring

  Example: https://meet.google.com/abc-xyz

• importancestring

  One of: low, normal, high, critical

• locationstring

  Example: Conference Room A

• descriptionstring

  Example: Monthly team sync meeting

• do_not_send_calendar_inviteboolean

  Example: false

• mark_as_doneboolean

  Example: false

• attachmentobject or null

  Example:
  "file_name": "agenda.pdf",
  "file_link": "https://..."

• created_byobject

  Example:
  "id": 1,
  "slug": "user_abc",
  "full_name": "John Doe",
  "email": "john@example.com"

• updated_byobject

  Example:
  "id": 1,
  "slug": "user_abc",
  "full_name": "John Doe",
  "email": "john@example.com"

• created_atstring (ISO 8601)

  Example: 2024-06-15T10:00:00Z

• updated_atstring (ISO 8601)

  Example: 2024-06-15T10:00:00Z

400

Body

• Validation error message

401

Body

• Unauthorized

Response Example

{
    "id": 42,
    "title": "Team Sync",
    "activity_type": {
        "id": 2,
        "label": "Meeting"
    },
    "related_to": "candidate_abc123",
    "related_record": {
        "slug": "candidate_abc123"
    },
    "related_to_type": "candidate",
    "collaborators": [
        {
            "id": 1,
            "slug": "user_abc",
            "full_name": "John Doe",
            "email": "john@example.com"
        }
    ],
    "start_date": "2024-06-15",
    "start_time": "10:00",
    "end_time": "11:00",
    "attendees": {
        "candidates": [
            { "slug": "cand_abc", "full_name": "Jane Smith" }
        ],
        "contacts": [],
        "users": [
            { "id": 2, "full_name": "Alice Johnson", "email": "alice@example.com" }
        ]
    },
    "meeting_link": "https://meet.google.com/abc-xyz",
    "importance": "high",
    "location": "Conference Room A",
    "description": "Monthly team sync",
    "do_not_send_calendar_invite": false,
    "mark_as_done": false,
    "attachment": null,
    "created_by": {
        "id": 1,
        "slug": "user_abc",
        "full_name": "John Doe",
        "email": "john@example.com"
    },
    "updated_by": {
        "id": 1,
        "slug": "user_abc",
        "full_name": "John Doe",
        "email": "john@example.com"
    },
    "created_at": "2024-06-15T10:00:00Z",
    "updated_at": "2024-06-15T10:00:00Z"
}