Loading ...

REST API: Add Persona | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Personas » REST API: Add Persona
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Add Persona

0 
 /5
0 (0votes)

REST API: Add Persona

POST /api/personas

Used to create a new persona. Valid for Communifire version 8 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
Name Used in the request body

Name of Persona created.
Optional Parameters How to use Description
IsEnabled Used in the request body

If Persona created is to be active or not.

True or False.

Default is False.
IncludeActions Used in the request body

Indicates if actions are included when conditions are met.

True or False.
RunActionOnSave Used in the request body

Indicates if actions made will run when persona is created.

True or False.
PersonaMatchCondition Used in the request body

0 = Match all conditions

1 = Match any conditions
ProfileFieldId Used in the request body. Within "PersonaConditions"[] array.

Field to compare condition with. See How to get a ProfileFieldId documentation.
ConditionOperatorType Used in the request body. Within "PersonaConditions"[] array.

Equals = 0,
Doesn't Equal = 1,
Contains = 2,
Doesn't Contain = 3,
Begins With = 4,
Ends With = 5,
Less Than Or Equal To = 6,
Less Than = 7,
Equal To = 8,
Greater Than = 9,
Greater Than Or Equal To = 10
ConditionValue Used in the request body. Within "PersonaConditions"[] array.

If condition is text, then a string value is here.

If condition is from a picklist:

  1. Use REST API: GET Profile Fields to get valid fields.
  2. Search for the picklist in result response.
  3. Find the desired choice in that picklist.
  4. Insert the OptionID here of that choice.
ActionType Used in the request body. Within "PersonaActions"[] array.

1 = Add to space

2 = Remove from space
ActionValue Used in the request body. Within "PersonaActions"[] array.

SpaceID to be added to or removed from.

Example Request

POST https://myintranet.communifire.com/api/personas

Example BODY:

This example uses:

  • The ProfileFieldID for Gender (67)
  • With the OptionID value from the Gender picklist for female (611) 
  • Adds it to spaceID 291
{
"Name": "Human Resources",
    "IsEnabled": true,
    "IncludeActions": true,
    "PersonaMatchCondition": 0,
    "RunActionsOnSave": false,
    "PersonaConditions":
        [{
          "ProfileFieldID": 67,
          "ConditionValue": 611,
          "ConditionOperatorType": 0
        }],
    "PersonaActions":
        [{
          "ActionValue": "291",
          "ActionType": 1
        }]
}

 

Example Response

{
    "IsError": false,
    "ResponseMessage": "Changes saved successfully",
    "ResponseData": {
        "PersonaID": 8,
        "Name": "Human Resources",
        "CreatedBy": 376,
        "UpdatedBy": 376,
        "LastUpdated": "2022-05-26T17:14:15.55",
        "IsEnabled": true,
        "IncludeActions": true,
        "PersonaMatchCondition": 0,
        "PersonaConditions": [
            {
                "ConditionID": 10,
                "PersonaID": 8,
                "ProfileFieldID": 67,
                "ConditionValue": "611",
                "CreatedBy": 376,
                "UpdatedBy": 376,
                "LastUpdated": "2022-05-26T17:14:15.557",
                "ConditionOperatorType": 0,
                "TenantID": 1
            }
        ],
        "PersonaActions": [
            {
                "ActionID": 4,
                "PersonaID": 8,
                "ActionValue": "291",
                "CreatedBy": 376,
                "UpdatedBy": 376,
                "LastUpdated": "2022-05-26T17:14:15.563",
                "ActionType": 1,
                "TenantID": 1
            }
        ],
        
        "LastUpdatedString": "just now",
        "RunActionsOnSave": false,
        "TenantID": 1
    }
}

is returned as ResponseData.

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software