> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Save Consent Purpose > Save a ConsentPurpose object NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/SaveConsentPurpose openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - ListAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/List/SaveConsentPurpose: post: tags: - List_Agent summary: Save Consent Purpose description: |- Save a ConsentPurpose object NsApiSlow threshold: 5000 ms. operationId: v1ListAgent_SaveConsentPurpose parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest description: ConsentPurpose required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ListCarriers.SaveConsentPurposeRequest: description: 'SaveConsentPurpose: Save a ConsentPurpose object' type: object properties: ConsentPurpose: $ref: '#/components/schemas/SuperOffice.CRM.Services.ConsentPurpose' SuperOffice.CRM.Services.ConsentPurpose: description: "Carrier object for ConsentPurpose.\r\nServices for the ConsentPurpose Carrier is available from the List Agent." type: object properties: ConsentPurposeId: format: int32 description: Primary key type: integer Name: description: Name of consent purpose type: string ConsentText: description: Form text used for the actual checkbox type: string FormText: description: >- Text for the consent form, the long text to be shown when asking the end-user for this kind of consent type: string Key: description: >- The key used to refer to this purpose, like #Process, #Emarketing etc. type: string Tooltip: description: List item tooltip type: string Active: format: int32 description: Is the consent purpose active or not type: integer UpdatedDate: format: date-time description: The date the consent purpose was last updated in UTC. type: string UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' Deleted: description: true if the ConsentPurpose is deleted type: boolean Rank: format: int32 description: Rank order type: integer PrivacyStatementDesc: description: Name or description for the privacy statement type: string PrivacyStatementUrl: description: Url referencing the actual privacy statement type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [Put Consent Purpose](/en/api/reference/restful/rest/list_consentpurpose/put-consent-purpose.md) - [Delete Consent Purpose](/en/api/reference/restful/rest/list_consentpurpose/delete-consent-purpose.md) - [Post Consent Purpose](/en/api/reference/restful/rest/list_consentpurpose/post-consent-purpose.md) - [SuperOffice.WebApi.Data.List SaveConsentPurposeRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_SaveConsentPurposeRequest.md) - [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.md) - [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)