Cameo meeting users

>>>

GET /api/v3/cameo_meetings/:cameo_meeting_id/users
List Users for a Cameo Meeting

Returns all Cameo Meeting Users

Errors

Code Description
404 Cameo Meeting or User not found

Examples

{
  "total_records": integer,
  "page_number": integer,
  "page_size": integer,
  "data": [
    {
      "id": integer,
      "email": string,
      "invitation_sent_at": datetime,
      "cameo_meeting_id": integer,
      "email_count": integer,
      "user": {
        "id": integer,
        "email": string,
        "first_name": string,
        "last_name": string,
        "created_at": datetime,
        "updated_at": datetime,
        "activated_at": datetime,
        "reset_code_at": datetime,
        "state": string,
        "deleted_at": datetime,
        "login_count": integer,
        "last_request_at": datetime,
        "current_login_at": datetime,
        "current_login_ip": string,
        "last_login_ip": string,

      }
    },
    ...
  ]
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:cameo_meeting_id/users/:id
Find User for a Cameo Meeting

Returns all of a Cameo Meeting User attributes

Errors

Code Description
404 Cameo Meeting or User not found

Examples

201 Response
{
  "id": integer,
  "email": string,
  "invitation_sent_at": datetime,
  "cameo_meeting_id": integer,
  "email_count": integer,
  "user": {
    "id": integer,
    "email": string,
    "first_name": string,
    "last_name": string,
    "created_at": datetime,
    "updated_at": datetime,
    "activated_at": datetime,
    "reset_code_at": datetime,
    "state": string,
    "deleted_at": datetime,
    "login_count": integer,
    "last_request_at": datetime,
    "current_login_at": datetime,
    "current_login_ip": string,
    "last_login_ip": string,

  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
id
required

ID of the Cameo Meeting User

Validations:

  • Must be a Integer
>>>

POST /api/v3/cameo_meetings/:cameo_meeting_id/users
Create User for a Cameo Meeting

Creates a user

Errors

Code Description
300 Error creating user
404 Cameo Meeting not found
422 Unable to process request, see errors in response

Examples

201 Response
{
  "id": integer,
  "email": string,
  "invitation_sent_at": datetime,
  "cameo_meeting_id": integer,
  "email_count": integer,
  "user": {
    "id": integer,
    "email": string,
    "first_name": string,
    "last_name": string,
    "created_at": datetime,
    "updated_at": datetime,
    "activated_at": datetime,
    "reset_code_at": datetime,
    "state": string,
    "deleted_at": datetime,
    "login_count": integer,
    "last_request_at": datetime,
    "current_login_at": datetime,
    "current_login_ip": string,
    "last_login_ip": string,

  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
id
required

ID of the Cameo Meeting User

Validations:

  • Must be a Integer
email
required

Email address of the Cameo Meeting User

Validations:

  • Must be a String
>>>

PATCH /api/v3/cameo_meetings/:cameo_meeting_id/users
Update User for a Cameo Meeting

Updates a user

Errors

Code Description
300 Error creating user
404 Cameo Meeting or User not found
422 Unable to process request, see errors in response

Examples

201 Response
{
  "id": integer,
  "email": string,
  "invitation_sent_at": datetime,
  "cameo_meeting_id": integer,
  "email_count": integer,
  "user": {
    "id": integer,
    "email": string,
    "first_name": string,
    "last_name": string,
    "created_at": datetime,
    "updated_at": datetime,
    "activated_at": datetime,
    "reset_code_at": datetime,
    "state": string,
    "deleted_at": datetime,
    "login_count": integer,
    "last_request_at": datetime,
    "current_login_at": datetime,
    "current_login_ip": string,
    "last_login_ip": string,

  }
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
id
required

ID of the Cameo Meeting User

Validations:

  • Must be a Integer
email
required

Email address of the Cameo Meeting User

Validations:

  • Must be a String
>>>

DELETE /api/v3/cameo_meetings/:cameo_meeting_id/users/:id
Delete User for a Cameo Meeting

Soft deletes a user, login disabled

Errors

Code Description
404 Cameo Meeting or User not found
422 Unable to process request, see errors in response

Examples

{
  "message": "Cameo Meeting User deleted successfully"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
id
required

ID of the Cameo Meeting User

Validations:

  • Must be a Integer
>>>

GET /api/v3/cameo_meetings/:cameo_meeting_id/users/:id/send_email
Send Email Cameo Meeting User

Sends Email to Cameo Meeting User

Errors

Code Description
300 Error sending email to Cameo Meeting Recipients
404 Cameo Meeting or User not found
422 Unable to process request, see errors in response

Examples

{
  "message": "Email sent successfully to Cameo Meeting User"
}

Params

Param name Description
token
required

API token for your organization

Validations:

  • Must be a String
cameo_meeting_id
required

ID of the Cameo Meeting

Validations:

  • Must be a Integer
id
required

ID of the Cameo Meeting User

Validations:

  • Must be a Integer