Skip to content
campaiDeveloper
campai.com

Crm · Conversations

POST/{organizationId}/{mandateId}/crm/conversations/assignee

Assign conversations

Assigns up to 100 conversations to a user who can read the inbox, or removes their assignment when no user is given. The change is added to each changed conversation as a note.

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • conversation.edit
Also checked, depending on the request and the records it touches
  • user.read
  • apiKey.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read
  • contact.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Body

Content-Type: application/json

  • conversationIdsid[]required

    1–100 items

  • userIdstringrequirednullable
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/conversations/assignee' \
  --header 'X-API-Key: YOUR_API_KEY'

No request that worked has been recorded yet, so the body is not shown.

Response

200 Successful response

Content-Type: application/json

  • assigneeobjectnullable
    4 properties
    • namestring
    • typestring
    • userIdstring
    • imageobjectnullable
      4 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

Response200
{
  "assignee": {
    "name": "string",
    "type": "user",
    "userId": "string",
    "image": {
      "resource": "string"
    }
  }
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.