Rev users

Update Rev User

Updates a Rev user.

POST
/rev-users.update

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?rev-users-update-request-artifacts
custom_fields?object

Application-defined custom fields.

Empty Object

custom_schema_fragments?rev-users-update-request-custom-schema-fragments
custom_schema_spec?custom-schema-spec

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

description?string

Updated description of the Rev user.

Formattext
display_name?string

Updated display name of the Rev user.

Formattext
display_picture?string | null

Artifact ID of a Rev user's updated display picture.

Formatid
email?string

Updated email address of the Rev user.

Formattext
external_ref?string

Updated external ref value of the Rev user.

Formattext
external_refs?array<string>

External refs are mutable unique identifiers for a contact record. If none are available, a good alternative is the email address(es)/phone number(s) which could uniquely identify the contact. If no identifier is specified, a system-generated identifier will be assigned to the contact. For organizations with multi-association contacts support enabled, this field accepts multiple identifiers, where each identifier must be unique across your DevOrg. For organizations without multi-association contacts support, this field accepts a single identifier, maintaining functionality consistent with the existing external_uid field.

idstring

The ID of Rev user to update.

Formatid
phone_numbers?array<string>

The phone numbers, in E.164 format, of the Rev user.

tags?array<set-tag-with-value>

Tags associated with the Rev user.

Response Body

curl -X POST "https://api.devrev.ai/rev-users.update" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
{
  "rev_user": {
    "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",
    "display_name": "string",
    "display_picture": {
      "display_id": "string",
      "id": "string",
      "file": {
        "type": "string",
        "name": "string",
        "size": 0
      }
    },
    "email": "string",
    "full_name": "string",
    "phone_numbers": [
      "string"
    ],
    "primary_identity": {
      "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"
    },
    "state": "active",
    "artifacts": [
      {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      }
    ],
    "custom_fields": {},
    "custom_schema_fragments": [
      "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
    ],
    "description": "string",
    "external_ref": "string",
    "external_refs": [
      "string"
    ],
    "is_verified": true,
    "rev_org": {
      "type": "account",
      "display_id": "string",
      "id": "string",
      "display_name": "string"
    },
    "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
    "subtype": "string",
    "tags": [
      {
        "tag": {
          "display_id": "string",
          "id": "string",
          "name": "string",
          "style_new": {
            "color": "string"
          }
        },
        "value": "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": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "conflict"
}
{
  "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"
}