Create Engagement

Creates a new engagement record.

Authorization

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

artifacts?array<string>

The IDs of the artifacts to associate with the engagement.

description?string

The description of the engagement.

Formattext

engagement_type?string

The type of engagement.

Value in"call" | "default" | "email" | "linked_in" | "offline"

external_ref?string

External Reference for the engagement.

Formattext

external_url?string

External URL for the engagement.

Formattext

membersarray<string>

IDs of the users that were part of the engagement.

Items1 <= items <= 50

parent?string

The parent object ID in which the engagement was created. Currently, only accounts and opportunities are supported.

Formatid

parents?array<string>

The parent object IDs to which the engagement is associated. Currently, only accounts and opportunities are supported.

scheduled_datestring

The date and time when the engagement was scheduled.

Formatdate-time

tags?

Tags associated with the engagement.

titlestring

The title of the engagement.

Formattext

Response Body

application/json

curl -X POST "https://api.devrev.ai/engagements.create" \
  -H "Content-Type: application/json" \
  -d '{
    "members": [
      "DEVU-12345"
    ],
    "scheduled_date": "2023-01-01T12:00:00.000Z",
    "title": "string"
  }'

curl -X POST "https://api.devrev.ai/engagements.create" \  -H "Content-Type: application/json" \  -d '{    "members": [      "DEVU-12345"    ],    "scheduled_date": "2023-01-01T12:00:00.000Z",    "title": "string"  }'

{
  "engagement": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "description": "string"
  }
}

{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}

{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}

{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}

{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}

{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}

{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}

Create Engagement

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

429application/json

500application/json

503application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json