Jump to

• Request
• Response

Create a collaboration recipient

post

/crmRestApi/resources/11.13.18.05/collaborationRecipientLookups

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AlternateGroupId: string
  Title: Collaboration Network Alternative Group ID

  Maximum Length: 255

  The alternative identifier of the collaboration network team or group that the resource belongs to.
• CollabGroupId: string
  Title: Collaboration Network Group ID

  Maximum Length: 255

  The identifier of the collaboration network team or group that the resource belongs to.
• CollabGroupName: string
  Title: Collaboration Network Group Name

  Maximum Length: 255

  The name of the collaboration network team or group that the resource belongs to.
• CollabId: string
  Title: Collaboration ID

  Maximum Length: 255

  The identifier of the collaboration resource in the collaboration network.
• DisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the collaboration resource.
• Name: string
  Title: Resource Name

  Maximum Length: 400

  The name of the collaboration resource.
• ResourceTypeCd: string
  Title: Resource Type

  Maximum Length: 30

  The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.
• TeamId: string
  Title: Team ID

  Maximum Length: 255

  The identifier of the collaboration network workspace that the resource belongs to.

{
    "type":"object",
    "properties":{
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.",
            "nullable":false
        },
        "CollabGroupId":{
            "title":"Collaboration Network Group ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "CollabGroupName":{
            "title":"Collaboration Network Group Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration resource in the collaboration network.",
            "nullable":false
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the collaboration resource.",
            "nullable":false
        },
        "TeamId":{
            "title":"Team ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration network workspace that the resource belongs to.",
            "nullable":false
        },
        "AlternateGroupId":{
            "title":"Collaboration Network Alternative Group ID",
            "maxLength":"255",
            "type":"string",
            "description":"The alternative identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true
        },
        "Name":{
            "title":"Resource Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the collaboration resource.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : collaborationRecipientLookups-item-response

Type: object

Show Source

• AlternateGroupId: string
  Title: Collaboration Network Alternative Group ID

  Maximum Length: 255

  The alternative identifier of the collaboration network team or group that the resource belongs to.
• ChannelId: string
  Read Only: true

  Maximum Length: 255

  The identifier of the CX Sales channel that is associated with the collaboration network workspace.
• CollabGroupId: string
  Title: Collaboration Network Group ID

  Maximum Length: 255

  The identifier of the collaboration network team or group that the resource belongs to.
• CollabGroupName: string
  Title: Collaboration Network Group Name

  Maximum Length: 255

  The name of the collaboration network team or group that the resource belongs to.
• CollabId: string
  Title: Collaboration ID

  Maximum Length: 255

  The identifier of the collaboration resource in the collaboration network.
• DisplayName: string
  Title: Display Name

  Maximum Length: 400

  The display name of the collaboration resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Resource Name

  Maximum Length: 400

  The name of the collaboration resource.
• ResourceId: integer (int64)
  Title: Resource ID

  Read Only: true

  The unique identifier of the collaboration resource.
• ResourceType: string
  Read Only: true

  Maximum Length: 255

  The display name of the collaboration resource type such as User, Channel, Private Channel.
• ResourceTypeCd: string
  Title: Resource Type

  Maximum Length: 30

  The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.
• TeamId: string
  Title: Team ID

  Maximum Length: 255

  The identifier of the collaboration network workspace that the resource belongs to.

{
    "type":"object",
    "properties":{
        "ResourceTypeCd":{
            "title":"Resource Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the collaboration resource such as USER, PUBLIC_CHANNEL, PRIVATE_CHANNEL.",
            "nullable":false,
            "x-queryable":true
        },
        "CollabGroupId":{
            "title":"Collaboration Network Group ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "CollabGroupName":{
            "title":"Collaboration Network Group Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollabId":{
            "title":"Collaboration ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration resource in the collaboration network.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"400",
            "type":"string",
            "description":"The display name of the collaboration resource.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceType":{
            "maxLength":"255",
            "type":"string",
            "description":"The display name of the collaboration resource type such as User, Channel, Private Channel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelId":{
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the CX Sales channel that is associated with the collaboration network workspace.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TeamId":{
            "title":"Team ID",
            "maxLength":"255",
            "type":"string",
            "description":"The identifier of the collaboration network workspace that the resource belongs to.",
            "nullable":false,
            "x-queryable":true
        },
        "AlternateGroupId":{
            "title":"Collaboration Network Alternative Group ID",
            "maxLength":"255",
            "type":"string",
            "description":"The alternative identifier of the collaboration network team or group that the resource belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Resource Name",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the collaboration resource.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top