Sign in
Membership

Create membership

Create a membership object.

post/api/v1/organization_groups/{organizationGroupID}/memberships

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

Request body

idinteger

ID of the membership

urlstring uri

URL of the membership

userstring uri

User URL.

organizationstring uri

Organization URL.

queuesstring[]

URLs of queues user has access to

expires_atstring date-time nullable

Timestamp of membership expiration. Membership won't expire if no expiration is set.

Example request

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/organization_groups/1/memberships/3",
  "user": "https://example.rossum.app/api/v1/users/10775",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/organization_groups/1/queues/3",
    "https://example.rossum.app/api/v1/organization_groups/1/queues/4"
  ]
}

Response

Created

idinteger required

ID of the membership

urlstring uri required

URL of the membership

userstring uri required

User URL.

organizationstring uri required

Organization URL.

queuesstring[] required

URLs of queues user has access to

expires_atstring date-time nullable required

Timestamp of membership expiration. Membership won't expire if no expiration is set.

Example response

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/organization_groups/1/memberships/3",
  "user": "https://example.rossum.app/api/v1/users/10775",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/organization_groups/1/queues/3",
    "https://example.rossum.app/api/v1/organization_groups/1/queues/4"
  ]
}

Changes

No recorded changes to this endpoint across all 2 revisions of this API.