Events.edit
From Facebook Developer Wiki
Contents |
Description
Edits the details of an existing event. The application must be an admin of the event. An application is the admin of an event if the application created the event on behalf of a user (with that user's active session) or if it is the creator of the event itself (that is, the event was created without an active user session).
This method does not require a session key. However if you call this method without an active user session, then your application can edit an event only if it is the event creator.
Parameters
| Required | Name | Type | Description | |
| required | api_key | string | The application key associated with the calling application. | |
|---|---|---|---|---|
| call_id | float | The request's sequence number. Each successive call for any session must use a sequence number greater than the last. We suggest using the current time in milliseconds, such as PHP's microtime(true) function. | ||
| sig | string | An MD5 hash of the current request and your secret key, as described in the How Facebook Authenticates Your Application. | ||
| v | string | This must be set to 1.0 to use this version of the API. | ||
| eid | int | The event ID. | ||
| event_info | object | The event information, passed as a JSON-encoded object. See the Notes below for information on what parameters you can change in the object. | ||
| optional | session_key | string | The session key of the logged in user. | |
| format | string | The desired response format, which can be either XML or JSON. (Default value is XML.) | ||
| callback | string | Name of a function to call. This is primarily to enable cross-domain JavaScript requests using the <script> tag, also known as JSONP, and works with both the XML and JSON formats. The function will be called with the response passed as the parameter. | ||
| data | The raw image data of the picture to associate with the event. |
Response
This method returns true if successful, or an error code otherwise.
Example Return XML
Error Codes
| Code | Description | |
| 1 | An unknown error occurred. Please resubmit the request. | |
|---|---|---|
| 2 | The service is not available at this time. | |
| 4 | The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed. | |
| 5 | The request came from a remote address not allowed by this application. | |
| 101 | The API key submitted is not associated with any known application. | |
| 102 | The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key. | |
| 103 | The submitted call_id was not greater than the previous call_id for this session. | |
| 104 | Incorrect signature. |
Notes
The following parameters in the event_info object are required and can only be edited, not deleted:
- city
- category
- subcategory
- host
- location
- start_time
- end_time
Note: The name cannot be edited. The start_time and end_time are the times that were input by the event creator, converted to UTC after assuming that they were in Pacific time (Daylight Savings or Standard, depending on the date of the event), then converted into Unix epoch time.
The following parameters in the event_info object are optional; thus, you can change or remove them entirely from an event:
- street
- phone
- host_id
- description
- privacy_type
- tagline
So a sample event_info object might look like:
When you set the delete_picture parameter in the event_info field, the picture currently associated with the event will be removed. You can upload a new event picture whether or not the event previously had a picture by uploading a picture with a call to this function. It is not necessary to set delete_picture when replacing an old event picture. See photos.upload for details on supported formats.
