Save Relationship

post

https://neon-loyalty-qa.spika.com/loyalty/v1/{space}/relationships/{relationshipLookupId}/connections

Path Params

space

string

required

The name of the space (database) assigned to you.

relationshipLookupId

string

required

One of:

The Entity's internal Entity Id
The Entity's name
The Entity's business Id, prefixed with $

Query Params

action

string

enum

RelationshipSave Action. Default is SET, which creates the Relationship if it doesn't already exists, and updates it if it exists. ADD_ONLY, will add a add the Relationsip if it doesn't already exist, but will not update an existing Relationship. UPDATE_ONLY is the opposite.

Allowed:

dim

string

The Dimensions under which the calling application operates. Format: {dim1}:{value1}[;{dim2}:{value2}[;...]]

includeUnpublished

boolean

If true, also exposes Installed but Unpublished entity resources. Default is false.

response

boolean

Defaults to false

If true, returns the saved content/resource. If false, the response content tag is not populated. Only set to true when the response payload is needed.

Body Params

relationshipId

string

The Relationship Entity Id

memberId

string

required

The member Id of the member for which the relationship was created (this is the owner of the relationship).
When querying it returns the Member Id, when writing it supports Member Lookup Id.
This field can't be updated.

relatedMemberId

string

required

The member Id of the other member which the relationship points to.
When querying it returns the Member Id, when writing it supports Member Lookup Id.
This field can't be updated.

data

json

Optional additional data in Json format

Response

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK