All Products
Search
Document Center

Resource Management:AssociateMembers

Last Updated:Dec 18, 2023

Binds a contact to a resource directory, folder, or member.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
ContactIdstringNo

The ID of the contact.

c-qL4HqKONzOM7****
MembersarrayNo

The IDs of objects to which you want to bind the contact.

stringNo

The ID of the object to which you want to bind the contact. Valid values:

  • ID of a resource directory
  • ID of a folder
  • ID of a member

Valid values of N: 1 to 5. This indicates that a maximum of five objects can be specified at a time.

fd-ZDNPiT****

Response parameters

ParameterTypeDescriptionExample
object

The returned result.

RequestIdstring

The request ID.

95060F1D-6990-4645-8920-A81D1BBFE992
Membersobject []

The time when the contact was bound to the object.

ContactIdstring

The ID of the contact.

c-qL4HqKONzOM7****
MemberIdstring

The ID of the object. Valid values:

  • ID of the resource directory
  • ID of the folder
  • ID of the member
fd-ZDNPiT****
ModifyDatestring

The time when the contact was bound to the object.

2023-03-27 17:19:21

Examples

Sample success responses

JSONformat

{
  "RequestId": "95060F1D-6990-4645-8920-A81D1BBFE992",
  "Members": [
    {
      "ContactId": "c-qL4HqKONzOM7****",
      "MemberId": "fd-ZDNPiT****",
      "ModifyDate": "2023-03-27 17:19:21"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidParameter.ContactIdThe ContactId is invalid.The value of the ContactId parameter is invalid.
400MissingParameter.ContactIdYou must specify ContactId.The ContactId parameter is not configured.
400InvalidParameter.MembersThe Members is invalid.The value of the Members parameter is invalid.
400InvalidParameter.Members.DuplicateThe Members contains duplicate values.Duplicate members are specified.
400LimitExceeded.ContactMembersThe maximum number of contact members exceeds the limit.The number of members exceeds the upper limit.
400InvalidMemberThe member does not exist in the resource directory.The specified member does not belong to the resource directory.
400ContactStatusMismatchActionThe status of the contact does not allow the specified operation.The status of the contact does not support the current operation.
404EntityNotExists.ContactThis Contact does not exist.The specified contact does not exist.
429ConcurrentCallNotSupportedThe operation conflicts with other operations. Please try again later.The operation conflicts with other operations. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history