BIbindbee
Activity

Create Activity

Changed on

Creates a Activity object with the given values.

post/api/ats/v1/activities

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer and API key in header X-Connector-Token

Request body

userstring uuid nullable required

The user who owns the activity.

activity_typestring nullable required

The type of activity. If the value is not one of the defined enum values, the original value passed through will be returned.

subjectstring nullable

The subject of the activity.

bodystring nullable required

The body of the activity. This can include notes, comments, or other relevant information.

visibilitystring nullable required

Visibility of the activity. If the value is not one of the defined enum values, the original value passed through will be returned.

candidatestring uuid nullable required

Candidate who applied for the activity.

Example request

{
  "user": "018b4bfb-5ece-70b1-ad5e-862a9433aa65",
  "activity_type": "NOTE",
  "subject": "Interview with John Doe",
  "body": "John Doe was interviewed for the position of Software Engineer.",
  "visibility": "PUBLIC",
  "candidate": "018b4bfb-5ece-70b1-ad5e-862a9433aa65"
}

Response

Successful Response

unknown required

Changes

  • 1f9bc0ad4bfbRevision changes
    • breaking

      removed the enum value ADMIN_ONLY of the request property

    • breaking

      removed the enum value EMAIL of the request property

    • breaking

      removed the enum value NOTE of the request property

    • breaking

      removed the enum value OTHER of the request property

    • breaking

      removed the enum value PRIVATE of the request property

    • breaking

      removed the enum value PUBLIC of the request property

    • info

      the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API

    • info

      the endpoint scheme security ConnectorToken was removed from the API

    • info

      the endpoint scheme security HTTPBearer was removed from the API

  • cf8209fb1cd7Revision changes
    • warning

      deleted the header request parameter x-connector-token

    • info

      the endpoint scheme security ConnectorToken was added to the API